executor

Documentation

Overview

Package executor calls UiPath services.

Index

• Constants
• type ExecutionContext
  • func NewExecutionContext(organization string, tenant string, method string, uri url.URL, route string, ...) *ExecutionContext
• type ExecutionContextParameters
  • func NewExecutionContextParameters(path []ExecutionParameter, query []ExecutionParameter, ...) *ExecutionContextParameters
• type ExecutionParameter
  • func NewExecutionParameter(name string, value interface{}) *ExecutionParameter
• type Executor
• type FileReference
  • func NewFileReference(path string) *FileReference
  • func NewFileReferenceData(filename string, data []byte) *FileReference
  • func (f FileReference) Data() (io.ReadCloser, int64, error)
  • func (f FileReference) Filename() string
• type HttpExecutor
  • func (e HttpExecutor) Call(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error
• type PluginExecutor
  • func (e PluginExecutor) Call(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error
• type TypeFormatter
  • func (f TypeFormatter) FormatHeader(parameter ExecutionParameter) string
  • func (f TypeFormatter) FormatPath(parameter ExecutionParameter) string
  • func (f TypeFormatter) FormatQueryString(parameter ExecutionParameter) string

Constants

const NotConfiguredErrorTemplate = `` /* 141-byte string literal not displayed */

Types

type ExecutionContext

type ExecutionContext struct {
	Organization string
	Tenant       string
	Method       string
	BaseUri      url.URL
	Route        string
	ContentType  string
	Input        *FileReference
	Parameters   ExecutionContextParameters
	AuthConfig   config.AuthConfig
	Insecure     bool
	Debug        bool
	Plugin       plugin.CommandPlugin
}

The ExecutionContext provides all the data needed by the executor to construct the HTTP request including URL, headers and body.

func NewExecutionContext

func NewExecutionContext(
	organization string,
	tenant string,
	method string,
	uri url.URL,
	route string,
	contentType string,
	input *FileReference,
	parameters ExecutionContextParameters,
	authConfig config.AuthConfig,
	insecure bool,
	debug bool,
	plugin plugin.CommandPlugin) *ExecutionContext

type ExecutionContextParameters

type ExecutionContextParameters struct {
	Path   []ExecutionParameter
	Query  []ExecutionParameter
	Header []ExecutionParameter
	Body   []ExecutionParameter
	Form   []ExecutionParameter
}

The ExecutionContextParameters contains list of parameters which are used by the executor to dynamically build the request.

func NewExecutionContextParameters

func NewExecutionContextParameters(
	path []ExecutionParameter,
	query []ExecutionParameter,
	header []ExecutionParameter,
	body []ExecutionParameter,
	form []ExecutionParameter) *ExecutionContextParameters

type ExecutionParameter

type ExecutionParameter struct {
	Name  string
	Value interface{}
}

An ExecutionParameter is a value which is used by the executor to build the request. Parameter values are typicall provided by multiple sources like config files, command line arguments and environment variables.

func NewExecutionParameter

func NewExecutionParameter(name string, value interface{}) *ExecutionParameter

type Executor

type Executor interface {
	Call(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error
}

The Executor interface is an abstraction for carrying out CLI commands.

The ExecutionContext provides all the data needed to execute a command. The OutputWriter should be used to output the result of the command. The Logger should be used for providing additional information when running a command.

type FileReference

type FileReference struct {
	// contains filtered or unexported fields
}

A FileReference provides access to binary data usually referencing a file on disk. This allows the executor to stream large files directly when sending the HTTP request instead of loading them in memory first.

The FileReference can also be initialized from byte array in case the data already resides in memory.

func NewFileReference

func NewFileReference(path string) *FileReference

func NewFileReferenceData

func NewFileReferenceData(filename string, data []byte) *FileReference

func (FileReference) Data

func (f FileReference) Data() (io.ReadCloser, int64, error)

func (FileReference) Filename

func (f FileReference) Filename() string

type HttpExecutor

type HttpExecutor struct {
	Authenticators []auth.Authenticator
}

The HttpExecutor implements the Executor interface and constructs HTTP request from the given command line parameters and configurations.

func (HttpExecutor) Call

func (e HttpExecutor) Call(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error

type PluginExecutor

type PluginExecutor struct {
	Authenticators []auth.Authenticator
}

The PluginExecutor implements the Executor interface and invokes the registered plugin for the executed command. The plugin takes care of sending the HTTP request or performing other operations.

func (PluginExecutor) Call

func (e PluginExecutor) Call(context ExecutionContext, writer output.OutputWriter, logger log.Logger) error

type TypeFormatter

type TypeFormatter struct{}

The TypeFormatter converts ExecutionParameter into parts of the http request. Depending on the type of the parameter, the formatter converts the value to the proper format.

func (TypeFormatter) FormatHeader

func (f TypeFormatter) FormatHeader(parameter ExecutionParameter) string

func (TypeFormatter) FormatPath

func (f TypeFormatter) FormatPath(parameter ExecutionParameter) string

func (TypeFormatter) FormatQueryString

func (f TypeFormatter) FormatQueryString(parameter ExecutionParameter) string