taskschedule

package
v0.46.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package taskschedule provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
	Oauth2Scopes     = "oauth2.Scopes"
)

Variables

This section is empty.

Functions

func NewDeleteScheduleTaskRequest

func NewDeleteScheduleTaskRequest(server string, taskScheduleName TaskScheduleName) (*http.Request, error)

NewDeleteScheduleTaskRequest generates requests for DeleteScheduleTask

func NewGetTaskScheduleRequest

func NewGetTaskScheduleRequest(server string, taskScheduleName TaskScheduleName) (*http.Request, error)

NewGetTaskScheduleRequest generates requests for GetTaskSchedule

func NewGetTaskSchedulesRequest

func NewGetTaskSchedulesRequest(server string, params *GetTaskSchedulesParams) (*http.Request, error)

NewGetTaskSchedulesRequest generates requests for GetTaskSchedules

func NewSubmitTaskScheduleRequest

func NewSubmitTaskScheduleRequest(server string, body SubmitTaskScheduleJSONRequestBody) (*http.Request, error)

NewSubmitTaskScheduleRequest calls the generic SubmitTaskSchedule builder with application/json body

func NewSubmitTaskScheduleRequestWithBody

func NewSubmitTaskScheduleRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewSubmitTaskScheduleRequestWithBody generates requests for SubmitTaskSchedule with any type of body

Types

type Action

type Action struct {
	ActionType           string                 `json:"action_type"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

Action defines model for Action.

func (Action) Get

func (a Action) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for Action. Returns the specified element and whether it was found

func (Action) MarshalJSON

func (a Action) MarshalJSON() ([]byte, error)

Override default JSON handling for Action to handle AdditionalProperties

func (*Action) Set

func (a *Action) Set(fieldName string, value interface{})

Setter for additional properties for Action

func (*Action) UnmarshalJSON

func (a *Action) UnmarshalJSON(b []byte) error

Override default JSON handling for Action to handle AdditionalProperties

type AsyncAction

type AsyncAction struct {
	ActionType string          `json:"action_type"`
	Async      *ListProperties `json:"async,omitempty"`
}

AsyncAction defines model for AsyncAction.

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) DeleteScheduleTask

func (c *Client) DeleteScheduleTask(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaskSchedule

func (c *Client) GetTaskSchedule(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTaskSchedules

func (c *Client) GetTaskSchedules(ctx context.Context, params *GetTaskSchedulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubmitTaskSchedule

func (c *Client) SubmitTaskSchedule(ctx context.Context, body SubmitTaskScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) SubmitTaskScheduleWithBody

func (c *Client) SubmitTaskScheduleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetTaskSchedules request
	GetTaskSchedules(ctx context.Context, params *GetTaskSchedulesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// SubmitTaskScheduleWithBody request with any body
	SubmitTaskScheduleWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	SubmitTaskSchedule(ctx context.Context, body SubmitTaskScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteScheduleTask request
	DeleteScheduleTask(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTaskSchedule request
	GetTaskSchedule(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) DeleteScheduleTaskWithResponse

func (c *ClientWithResponses) DeleteScheduleTaskWithResponse(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*DeleteScheduleTaskHTTPResp, error)

DeleteScheduleTaskWithResponse request returning *DeleteScheduleTaskHTTPResp

func (*ClientWithResponses) GetTaskScheduleWithResponse

func (c *ClientWithResponses) GetTaskScheduleWithResponse(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*GetTaskScheduleHTTPResp, error)

GetTaskScheduleWithResponse request returning *GetTaskScheduleHTTPResp

func (*ClientWithResponses) GetTaskSchedulesWithResponse

func (c *ClientWithResponses) GetTaskSchedulesWithResponse(ctx context.Context, params *GetTaskSchedulesParams, reqEditors ...RequestEditorFn) (*GetTaskSchedulesHTTPResp, error)

GetTaskSchedulesWithResponse request returning *GetTaskSchedulesHTTPResp

func (*ClientWithResponses) SubmitTaskScheduleWithBodyWithResponse

func (c *ClientWithResponses) SubmitTaskScheduleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitTaskScheduleHTTPResp, error)

SubmitTaskScheduleWithBodyWithResponse request with arbitrary body returning *SubmitTaskScheduleHTTPResp

func (*ClientWithResponses) SubmitTaskScheduleWithResponse

func (c *ClientWithResponses) SubmitTaskScheduleWithResponse(ctx context.Context, body SubmitTaskScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitTaskScheduleHTTPResp, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetTaskSchedulesWithResponse request
	GetTaskSchedulesWithResponse(ctx context.Context, params *GetTaskSchedulesParams, reqEditors ...RequestEditorFn) (*GetTaskSchedulesHTTPResp, error)

	// SubmitTaskScheduleWithBodyWithResponse request with any body
	SubmitTaskScheduleWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*SubmitTaskScheduleHTTPResp, error)

	SubmitTaskScheduleWithResponse(ctx context.Context, body SubmitTaskScheduleJSONRequestBody, reqEditors ...RequestEditorFn) (*SubmitTaskScheduleHTTPResp, error)

	// DeleteScheduleTaskWithResponse request
	DeleteScheduleTaskWithResponse(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*DeleteScheduleTaskHTTPResp, error)

	// GetTaskScheduleWithResponse request
	GetTaskScheduleWithResponse(ctx context.Context, taskScheduleName TaskScheduleName, reqEditors ...RequestEditorFn) (*GetTaskScheduleHTTPResp, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type CodeblockAction

type CodeblockAction struct {
	ActionType string `json:"action_type"`
	Codeblock  *struct {
		Actions   []Action                  `json:"actions"`
		Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

		// Condition a javascript if not set or if it returns true then the action is executed
		Condition *string                 `json:"condition,omitempty"`
		Error     *ErrorHandlingConfig    `json:"error,omitempty"`
		Parameter *map[string]interface{} `json:"parameter,omitempty"`
		Timeout   *int64                  `json:"timeout,omitempty"`
		Var       *string                 `json:"var,omitempty"`
	} `json:"codeblock,omitempty"`
}

CodeblockAction defines model for CodeblockAction.

type CodeblockProperties

type CodeblockProperties struct {
	Actions []Action `json:"actions"`
}

CodeblockProperties defines model for CodeblockProperties.

type CodeblockReferenceAction

type CodeblockReferenceAction struct {
	ActionType string `json:"action_type"`
	Codeblock  *struct {
		Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

		// Condition a javascript if not set or if it returns true then the action is executed
		Condition *string                 `json:"condition,omitempty"`
		Error     *ErrorHandlingConfig    `json:"error,omitempty"`
		Parameter *map[string]interface{} `json:"parameter,omitempty"`
		Ref       ReferenceProperties     `json:"ref"`
		Timeout   *int64                  `json:"timeout,omitempty"`
		Var       *string                 `json:"var,omitempty"`
	} `json:"codeblock,omitempty"`
}

CodeblockReferenceAction defines model for CodeblockReferenceAction.

type CodeblockReferenceProperties

type CodeblockReferenceProperties struct {
	Ref ReferenceProperties `json:"ref"`
}

CodeblockReferenceProperties A reference to a stored codeblock. Either the identifier or the name need to be specified.

type CommonActionProperties

type CommonActionProperties struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`
	Timeout   *int64               `json:"timeout,omitempty"`
	Var       *string              `json:"var,omitempty"`
}

CommonActionProperties defines model for CommonActionProperties.

type CommonCodeblockProperties

type CommonCodeblockProperties struct {
	Parameter *map[string]interface{} `json:"parameter,omitempty"`
}

CommonCodeblockProperties defines model for CommonCodeblockProperties.

type DeleteScheduleTaskHTTPResp

type DeleteScheduleTaskHTTPResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteScheduleTaskHTTPResp

func ParseDeleteScheduleTaskHTTPResp(rsp *http.Response) (*DeleteScheduleTaskHTTPResp, error)

ParseDeleteScheduleTaskHTTPResp parses an HTTP response from a DeleteScheduleTaskWithResponse call

func (DeleteScheduleTaskHTTPResp) Status

Status returns HTTPResponse.Status

func (DeleteScheduleTaskHTTPResp) StatusCode

func (r DeleteScheduleTaskHTTPResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ErrorContextPropagationBehavior

type ErrorContextPropagationBehavior string

ErrorContextPropagationBehavior controls if an error response should be added to the context, an error is only added if there is a var for that action. show - an error response is added to the context in {varName}.["error.response"], hide - does not add the error response to the context.

Defines values for ErrorContextPropagationBehavior.

type ErrorHandlingBehavior

type ErrorHandlingBehavior string

ErrorHandlingBehavior changes behavior if an error continues. stop - does not execute further actions in the same pipeline, continue - executes the next action regardless of a failure, enables that an error can be handled explicitly.

const (
	ErrorHandlingBehaviorContinue ErrorHandlingBehavior = "continue"
	ErrorHandlingBehaviorStop     ErrorHandlingBehavior = "stop"
)

Defines values for ErrorHandlingBehavior.

type ErrorHandlingConfig

type ErrorHandlingConfig struct {
	// Handling changes behavior if an error continues. stop - does not execute further actions in the same pipeline, continue - executes the next action regardless of a failure, enables that an error can be handled explicitly.
	Handling *ErrorHandlingBehavior `json:"handling,omitempty"`

	// Visibility controls if an error response should be added to the context, an error is only added if there is a var for that action. show - an error response is added to the context in {varName}.["error.response"], hide - does not add the error response to the context.
	Visibility *ErrorContextPropagationBehavior `json:"visibility,omitempty"`
}

ErrorHandlingConfig defines model for ErrorHandlingConfig.

type GenericAction

type GenericAction = Action

GenericAction defines model for GenericAction.

type GetTaskScheduleHTTPResp

type GetTaskScheduleHTTPResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaskScheduleResponse
}

func ParseGetTaskScheduleHTTPResp

func ParseGetTaskScheduleHTTPResp(rsp *http.Response) (*GetTaskScheduleHTTPResp, error)

ParseGetTaskScheduleHTTPResp parses an HTTP response from a GetTaskScheduleWithResponse call

func (GetTaskScheduleHTTPResp) Status

func (r GetTaskScheduleHTTPResp) Status() string

Status returns HTTPResponse.Status

func (GetTaskScheduleHTTPResp) StatusCode

func (r GetTaskScheduleHTTPResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskSchedulesHTTPResp

type GetTaskSchedulesHTTPResp struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TaskScheduleListResponse
}

func ParseGetTaskSchedulesHTTPResp

func ParseGetTaskSchedulesHTTPResp(rsp *http.Response) (*GetTaskSchedulesHTTPResp, error)

ParseGetTaskSchedulesHTTPResp parses an HTTP response from a GetTaskSchedulesWithResponse call

func (GetTaskSchedulesHTTPResp) Status

func (r GetTaskSchedulesHTTPResp) Status() string

Status returns HTTPResponse.Status

func (GetTaskSchedulesHTTPResp) StatusCode

func (r GetTaskSchedulesHTTPResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTaskSchedulesParams

type GetTaskSchedulesParams struct {
	// Page page index, "1" based.
	Page *QueryPage `form:"page,omitempty" json:"page,omitempty"`

	// PageSize page size, "1..100" based.
	PageSize *QueryPageSize `form:"page_size,omitempty" json:"page_size,omitempty"`
}

GetTaskSchedulesParams defines parameters for GetTaskSchedules.

type Http

type Http struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Body payload of the http call
	Body             *map[string]interface{} `json:"body,omitempty"`
	CheckCertificate *bool                   `json:"checkCertificate,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string                 `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig    `json:"error,omitempty"`
	Header    *map[string]interface{} `json:"header,omitempty"`

	// MTLS any parameters of mTLS should be referenced as {{secrets.whatever.key}}, {{secrets.whatever.cert}},  {{secrets.whatever.ca_cert}} etc.
	MTLS *struct {
		// CaCert public CA certificate used to create the server certificate
		CaCert string `json:"ca_cert"`

		// Cert client certificate accepted by the target server
		Cert string `json:"cert"`

		// Key client private key
		Key string `json:"key"`
	} `json:"mTLS,omitempty"`

	// Method http method
	Method string `json:"method"`

	// QueryParams flat key value object
	QueryParams *map[string]interface{} `json:"queryParams,omitempty"`
	Timeout     *int64                  `json:"timeout,omitempty"`
	Url         string                  `json:"url"`
	Var         *string                 `json:"var,omitempty"`
}

Http defines model for Http.

type HttpAction

type HttpAction struct {
	ActionType           string                 `json:"action_type"`
	Http                 *Http                  `json:"http,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

HttpAction defines model for HttpAction.

func (HttpAction) Get

func (a HttpAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for HttpAction. Returns the specified element and whether it was found

func (HttpAction) MarshalJSON

func (a HttpAction) MarshalJSON() ([]byte, error)

Override default JSON handling for HttpAction to handle AdditionalProperties

func (*HttpAction) Set

func (a *HttpAction) Set(fieldName string, value interface{})

Setter for additional properties for HttpAction

func (*HttpAction) UnmarshalJSON

func (a *HttpAction) UnmarshalJSON(b []byte) error

Override default JSON handling for HttpAction to handle AdditionalProperties

type HttpActionProperties

type HttpActionProperties struct {
	// Body payload of the http call
	Body             *map[string]interface{} `json:"body,omitempty"`
	CheckCertificate *bool                   `json:"checkCertificate,omitempty"`
	Header           *map[string]interface{} `json:"header,omitempty"`

	// MTLS any parameters of mTLS should be referenced as {{secrets.whatever.key}}, {{secrets.whatever.cert}},  {{secrets.whatever.ca_cert}} etc.
	MTLS *struct {
		// CaCert public CA certificate used to create the server certificate
		CaCert string `json:"ca_cert"`

		// Cert client certificate accepted by the target server
		Cert string `json:"cert"`

		// Key client private key
		Key string `json:"key"`
	} `json:"mTLS,omitempty"`

	// Method http method
	Method string `json:"method"`

	// QueryParams flat key value object
	QueryParams *map[string]interface{} `json:"queryParams,omitempty"`
	Url         string                  `json:"url"`
}

HttpActionProperties defines model for HttpActionProperties.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type IntegrationProxy

type IntegrationProxy struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition     *string                 `json:"condition,omitempty"`
	Context       *map[string]interface{} `json:"context,omitempty"`
	Error         *ErrorHandlingConfig    `json:"error,omitempty"`
	IntegrationId string                  `json:"integration_id"`
	Params        *map[string]interface{} `json:"params,omitempty"`

	// QueryParams flat object of query parameters
	QueryParams *map[string]interface{} `json:"queryParams,omitempty"`
	Timeout     *int64                  `json:"timeout,omitempty"`
	Type        string                  `json:"type"`
	Var         *string                 `json:"var,omitempty"`
}

IntegrationProxy defines model for IntegrationProxy.

type IntegrationProxyAction

type IntegrationProxyAction struct {
	Action               *IntegrationProxy      `json:"action,omitempty"`
	ActionType           string                 `json:"action_type"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

IntegrationProxyAction defines model for IntegrationProxyAction.

func (IntegrationProxyAction) Get

func (a IntegrationProxyAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for IntegrationProxyAction. Returns the specified element and whether it was found

func (IntegrationProxyAction) MarshalJSON

func (a IntegrationProxyAction) MarshalJSON() ([]byte, error)

Override default JSON handling for IntegrationProxyAction to handle AdditionalProperties

func (*IntegrationProxyAction) Set

func (a *IntegrationProxyAction) Set(fieldName string, value interface{})

Setter for additional properties for IntegrationProxyAction

func (*IntegrationProxyAction) UnmarshalJSON

func (a *IntegrationProxyAction) UnmarshalJSON(b []byte) error

Override default JSON handling for IntegrationProxyAction to handle AdditionalProperties

type IntegrationProxyProperties

type IntegrationProxyProperties struct {
	Context       *map[string]interface{} `json:"context,omitempty"`
	IntegrationId string                  `json:"integration_id"`
	Params        *map[string]interface{} `json:"params,omitempty"`

	// QueryParams flat object of query parameters
	QueryParams *map[string]interface{} `json:"queryParams,omitempty"`
	Type        string                  `json:"type"`
}

IntegrationProxyProperties defines model for IntegrationProxyProperties.

type IterationAction

type IterationAction struct {
	ActionType string `json:"action_type"`
	Iteration  *struct {
		Actions   *[]TypedAction            `json:"actions,omitempty"`
		Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

		// Condition a javascript if not set or if it returns true then the action is executed
		Condition *string                  `json:"condition,omitempty"`
		Error     *ErrorHandlingConfig     `json:"error,omitempty"`
		Items     []map[string]interface{} `json:"items"`

		// ItemsMax  The number of items specified for iteration. If you supply more elements, a runtime error will occur. Additionally, when increasing this limit beyond the default, consider setting the timeout property on both the state, parents and iteration.
		ItemsMax *int `json:"items_max,omitempty"`

		// OnError on child error continue or fail the iteration
		OnError *IterationActionIterationOnError `json:"onError,omitempty"`
		Result  IterationActionIterationResult   `json:"result"`
		Timeout *int64                           `json:"timeout,omitempty"`
		Var     *string                          `json:"var,omitempty"`
	} `json:"iteration,omitempty"`
}

IterationAction defines model for IterationAction.

type IterationActionIterationOnError

type IterationActionIterationOnError string

IterationActionIterationOnError on child error continue or fail the iteration

const (
	IterationActionIterationOnErrorContinue IterationActionIterationOnError = "continue"
	IterationActionIterationOnErrorFail     IterationActionIterationOnError = "fail"
)

Defines values for IterationActionIterationOnError.

type IterationActionIterationResult

type IterationActionIterationResult string

IterationActionIterationResult defines model for IterationAction.Iteration.Result.

const (
	IterationActionIterationResultFull   IterationActionIterationResult = "full"
	IterationActionIterationResultSingle IterationActionIterationResult = "single"
)

Defines values for IterationActionIterationResult.

type IterationProperties

type IterationProperties struct {
	Actions *[]TypedAction           `json:"actions,omitempty"`
	Items   []map[string]interface{} `json:"items"`

	// ItemsMax  The number of items specified for iteration. If you supply more elements, a runtime error will occur. Additionally, when increasing this limit beyond the default, consider setting the timeout property on both the state, parents and iteration.
	ItemsMax *int `json:"items_max,omitempty"`

	// OnError on child error continue or fail the iteration
	OnError *IterationPropertiesOnError `json:"onError,omitempty"`
	Result  IterationPropertiesResult   `json:"result"`
}

IterationProperties defines model for IterationProperties.

type IterationPropertiesOnError

type IterationPropertiesOnError string

IterationPropertiesOnError on child error continue or fail the iteration

const (
	Continue IterationPropertiesOnError = "continue"
	Fail     IterationPropertiesOnError = "fail"
)

Defines values for IterationPropertiesOnError.

type IterationPropertiesResult

type IterationPropertiesResult string

IterationPropertiesResult defines model for IterationProperties.Result.

const (
	IterationPropertiesResultFull   IterationPropertiesResult = "full"
	IterationPropertiesResultSingle IterationPropertiesResult = "single"
)

Defines values for IterationPropertiesResult.

type JWTCreate

type JWTCreate struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`

	// ExpireIn Milliseconds
	ExpireIn *Milliseconds `json:"expireIn,omitempty"`

	// Header The header typically consists of two parts. Type of the token, which is JWT, and the signing algorithm being used, such as HMAC SHA256 or RSA see https://jwt.io/introduction
	Header map[string]interface{} `json:"header"`

	// Payload Payload that contains claims that are statements about an entity (typically, the user) and additional data see https://jwt.io/introduction
	Payload map[string]interface{} `json:"payload"`

	// SignKey Key ued to sign the JWT, must match the type specified in the header 'alg'.
	SignKey *string `json:"signKey,omitempty"`
	Timeout *int64  `json:"timeout,omitempty"`
	Var     *string `json:"var,omitempty"`
}

JWTCreate defines model for JWTCreate.

type JWTCreateAction

type JWTCreateAction struct {
	ActionType           string                 `json:"action_type"`
	Jwt                  *JWTCreate             `json:"jwt,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

JWTCreateAction defines model for JWTCreateAction.

func (JWTCreateAction) Get

func (a JWTCreateAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for JWTCreateAction. Returns the specified element and whether it was found

func (JWTCreateAction) MarshalJSON

func (a JWTCreateAction) MarshalJSON() ([]byte, error)

Override default JSON handling for JWTCreateAction to handle AdditionalProperties

func (*JWTCreateAction) Set

func (a *JWTCreateAction) Set(fieldName string, value interface{})

Setter for additional properties for JWTCreateAction

func (*JWTCreateAction) UnmarshalJSON

func (a *JWTCreateAction) UnmarshalJSON(b []byte) error

Override default JSON handling for JWTCreateAction to handle AdditionalProperties

type JWTCreateProperties

type JWTCreateProperties struct {
	// ExpireIn Milliseconds
	ExpireIn *Milliseconds `json:"expireIn,omitempty"`

	// Header The header typically consists of two parts. Type of the token, which is JWT, and the signing algorithm being used, such as HMAC SHA256 or RSA see https://jwt.io/introduction
	Header map[string]interface{} `json:"header"`

	// Payload Payload that contains claims that are statements about an entity (typically, the user) and additional data see https://jwt.io/introduction
	Payload map[string]interface{} `json:"payload"`

	// SignKey Key ued to sign the JWT, must match the type specified in the header 'alg'.
	SignKey *string `json:"signKey,omitempty"`
}

JWTCreateProperties defines model for JWTCreateProperties.

type JavaScript

type JavaScript struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`
	Code      string                    `json:"code"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`
	Timeout   *int64               `json:"timeout,omitempty"`
	Var       *string              `json:"var,omitempty"`
}

JavaScript defines model for JavaScript.

type JavaScriptAction

type JavaScriptAction struct {
	ActionType           string                 `json:"action_type"`
	Js                   *JavaScript            `json:"js,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

JavaScriptAction defines model for JavaScriptAction.

func (JavaScriptAction) Get

func (a JavaScriptAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for JavaScriptAction. Returns the specified element and whether it was found

func (JavaScriptAction) MarshalJSON

func (a JavaScriptAction) MarshalJSON() ([]byte, error)

Override default JSON handling for JavaScriptAction to handle AdditionalProperties

func (*JavaScriptAction) Set

func (a *JavaScriptAction) Set(fieldName string, value interface{})

Setter for additional properties for JavaScriptAction

func (*JavaScriptAction) UnmarshalJSON

func (a *JavaScriptAction) UnmarshalJSON(b []byte) error

Override default JSON handling for JavaScriptAction to handle AdditionalProperties

type JavaScriptProperties

type JavaScriptProperties struct {
	Code string `json:"code"`
}

JavaScriptProperties defines model for JavaScriptProperties.

type JavaScriptReference

type JavaScriptReference struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`
	Ref       ReferenceProperties  `json:"ref"`
	Timeout   *int64               `json:"timeout,omitempty"`
	Var       *string              `json:"var,omitempty"`
}

JavaScriptReference defines model for JavaScriptReference.

type JavaScriptReferenceAction

type JavaScriptReferenceAction struct {
	ActionType           string                 `json:"action_type"`
	JsRef                *JavaScriptReference   `json:"js_ref,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

JavaScriptReferenceAction defines model for JavaScriptReferenceAction.

func (JavaScriptReferenceAction) Get

func (a JavaScriptReferenceAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for JavaScriptReferenceAction. Returns the specified element and whether it was found

func (JavaScriptReferenceAction) MarshalJSON

func (a JavaScriptReferenceAction) MarshalJSON() ([]byte, error)

Override default JSON handling for JavaScriptReferenceAction to handle AdditionalProperties

func (*JavaScriptReferenceAction) Set

func (a *JavaScriptReferenceAction) Set(fieldName string, value interface{})

Setter for additional properties for JavaScriptReferenceAction

func (*JavaScriptReferenceAction) UnmarshalJSON

func (a *JavaScriptReferenceAction) UnmarshalJSON(b []byte) error

Override default JSON handling for JavaScriptReferenceAction to handle AdditionalProperties

type JavaScriptReferenceProperties

type JavaScriptReferenceProperties struct {
	Ref ReferenceProperties `json:"ref"`
}

JavaScriptReferenceProperties A reference to a stored java script. Either the identifier or the name need to be specified.

type ListProperties

type ListProperties = []TypedAction

ListProperties defines model for ListProperties.

type LogAction

type LogAction struct {
	ActionType           string                 `json:"action_type"`
	Log                  *LogActionData         `json:"log,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

LogAction defines model for LogAction.

func (LogAction) Get

func (a LogAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for LogAction. Returns the specified element and whether it was found

func (LogAction) MarshalJSON

func (a LogAction) MarshalJSON() ([]byte, error)

Override default JSON handling for LogAction to handle AdditionalProperties

func (*LogAction) Set

func (a *LogAction) Set(fieldName string, value interface{})

Setter for additional properties for LogAction

func (*LogAction) UnmarshalJSON

func (a *LogAction) UnmarshalJSON(b []byte) error

Override default JSON handling for LogAction to handle AdditionalProperties

type LogActionData

type LogActionData struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`
	Message   *string              `json:"message,omitempty"`
	Timeout   *int64               `json:"timeout,omitempty"`
	Var       *string              `json:"var,omitempty"`
}

LogActionData defines model for LogActionData.

type LogProperties

type LogProperties struct {
	Message *string `json:"message,omitempty"`
}

LogProperties defines model for LogProperties.

type Milliseconds

type Milliseconds = int64

Milliseconds Milliseconds

type Noop

type Noop struct {
	Arguments *[]map[string]interface{} `json:"arguments,omitempty"`

	// Condition a javascript if not set or if it returns true then the action is executed
	Condition *string              `json:"condition,omitempty"`
	Error     *ErrorHandlingConfig `json:"error,omitempty"`
	Timeout   *int64               `json:"timeout,omitempty"`
	Var       *string              `json:"var,omitempty"`
}

Noop defines model for Noop.

type NoopAction

type NoopAction struct {
	ActionType           string                 `json:"action_type"`
	Noop                 *Noop                  `json:"noop,omitempty"`
	AdditionalProperties map[string]interface{} `json:"-"`
}

NoopAction defines model for NoopAction.

func (NoopAction) Get

func (a NoopAction) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for NoopAction. Returns the specified element and whether it was found

func (NoopAction) MarshalJSON

func (a NoopAction) MarshalJSON() ([]byte, error)

Override default JSON handling for NoopAction to handle AdditionalProperties

func (*NoopAction) Set

func (a *NoopAction) Set(fieldName string, value interface{})

Setter for additional properties for NoopAction

func (*NoopAction) UnmarshalJSON

func (a *NoopAction) UnmarshalJSON(b []byte) error

Override default JSON handling for NoopAction to handle AdditionalProperties

type NoopProperties

type NoopProperties = map[string]interface{}

NoopProperties defines model for NoopProperties.

type PageMetadata

type PageMetadata struct {
	Page       *int `json:"page,omitempty"`
	PageCount  *int `json:"page_count,omitempty"`
	PerPage    *int `json:"per_page,omitempty"`
	TotalCount *int `json:"total_count,omitempty"`
}

PageMetadata defines model for PageMetadata.

type PipelineAction

type PipelineAction struct {
	ActionType string          `json:"action_type"`
	Pipeline   *ListProperties `json:"pipeline,omitempty"`
}

PipelineAction defines model for PipelineAction.

type QueryPage

type QueryPage = int64

QueryPage defines model for queryPage.

type QueryPageSize

type QueryPageSize = int64

QueryPageSize defines model for queryPageSize.

type ReferenceProperties

type ReferenceProperties struct {
	// Identifier system unique id to address the reference.
	Identifier *string `json:"identifier,omitempty"`

	// Name account unique name of the reference to address it
	Name *string `json:"name,omitempty"`
}

ReferenceProperties defines model for ReferenceProperties.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SubmitTaskSchedule

type SubmitTaskSchedule struct {
	Cron          string                 `json:"cron"`
	Name          string                 `json:"name"`
	Task          map[string]interface{} `json:"task"`
	TemplateId    *string                `json:"template_id,omitempty"`
	TemplateStyle *TemplateStyle         `json:"template_style,omitempty"`

	// Timezone A valid IANA timezone for examples see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Note: Be careful when setting fire times between the hours of the morning when “daylight savings” changes occur in your locale (for US locales, this would typically be the hour before and after 2:00 AM - because the time shift can cause a skip or a repeat depending on whether the time moves back or jumps forward. You may find this wikipedia entry helpful in determining the specifics to your locale https://secure.wikimedia.org/wikipedia/en/wiki/Daylight_saving_time_around_the_world
	Timezone *Timezone `json:"timezone,omitempty"`
}

SubmitTaskSchedule defines model for SubmitTaskSchedule.

type SubmitTaskScheduleBody

type SubmitTaskScheduleBody = SubmitTaskSchedule

SubmitTaskScheduleBody defines model for submitTaskScheduleBody.

type SubmitTaskScheduleHTTPResp

type SubmitTaskScheduleHTTPResp struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseSubmitTaskScheduleHTTPResp

func ParseSubmitTaskScheduleHTTPResp(rsp *http.Response) (*SubmitTaskScheduleHTTPResp, error)

ParseSubmitTaskScheduleHTTPResp parses an HTTP response from a SubmitTaskScheduleWithResponse call

func (SubmitTaskScheduleHTTPResp) Status

Status returns HTTPResponse.Status

func (SubmitTaskScheduleHTTPResp) StatusCode

func (r SubmitTaskScheduleHTTPResp) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SubmitTaskScheduleJSONRequestBody

type SubmitTaskScheduleJSONRequestBody = SubmitTaskSchedule

SubmitTaskScheduleJSONRequestBody defines body for SubmitTaskSchedule for application/json ContentType.

type TaskSchedule

type TaskSchedule struct {
	Cron          string                  `json:"cron"`
	Name          *string                 `json:"name,omitempty"`
	Task          *map[string]interface{} `json:"task,omitempty"`
	TemplateId    *string                 `json:"template_id,omitempty"`
	TemplateStyle *TemplateStyle          `json:"template_style,omitempty"`

	// Timezone A valid IANA timezone for examples see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Note: Be careful when setting fire times between the hours of the morning when “daylight savings” changes occur in your locale (for US locales, this would typically be the hour before and after 2:00 AM - because the time shift can cause a skip or a repeat depending on whether the time moves back or jumps forward. You may find this wikipedia entry helpful in determining the specifics to your locale https://secure.wikimedia.org/wikipedia/en/wiki/Daylight_saving_time_around_the_world
	Timezone *Timezone `json:"timezone,omitempty"`
}

TaskSchedule defines model for TaskSchedule.

type TaskScheduleList

type TaskScheduleList struct {
	Metadata *PageMetadata   `json:"_metadata,omitempty"`
	Records  *[]TaskSchedule `json:"records,omitempty"`
}

TaskScheduleList defines model for TaskScheduleList.

type TaskScheduleListResponse

type TaskScheduleListResponse = TaskScheduleList

TaskScheduleListResponse defines model for taskScheduleListResponse.

type TaskScheduleName

type TaskScheduleName = string

TaskScheduleName defines model for taskScheduleName.

type TaskScheduleResponse

type TaskScheduleResponse = TaskSchedule

TaskScheduleResponse defines model for taskScheduleResponse.

type TemplateStyle

type TemplateStyle string

TemplateStyle defines model for TemplateStyle.

const (
	Flat      TemplateStyle = "flat"
	Hierarchy TemplateStyle = "hierarchy"
)

Defines values for TemplateStyle.

type Timezone

type Timezone = string

Timezone A valid IANA timezone for examples see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Note: Be careful when setting fire times between the hours of the morning when “daylight savings” changes occur in your locale (for US locales, this would typically be the hour before and after 2:00 AM - because the time shift can cause a skip or a repeat depending on whether the time moves back or jumps forward. You may find this wikipedia entry helpful in determining the specifics to your locale https://secure.wikimedia.org/wikipedia/en/wiki/Daylight_saving_time_around_the_world

type TypedAction

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

TypedAction defines model for TypedAction.

func (TypedAction) AsAsyncAction

func (t TypedAction) AsAsyncAction() (AsyncAction, error)

AsAsyncAction returns the union data inside the TypedAction as a AsyncAction

func (TypedAction) AsCodeblockAction

func (t TypedAction) AsCodeblockAction() (CodeblockAction, error)

AsCodeblockAction returns the union data inside the TypedAction as a CodeblockAction

func (TypedAction) AsCodeblockReferenceAction

func (t TypedAction) AsCodeblockReferenceAction() (CodeblockReferenceAction, error)

AsCodeblockReferenceAction returns the union data inside the TypedAction as a CodeblockReferenceAction

func (TypedAction) AsGenericAction

func (t TypedAction) AsGenericAction() (GenericAction, error)

AsGenericAction returns the union data inside the TypedAction as a GenericAction

func (TypedAction) AsHttpAction

func (t TypedAction) AsHttpAction() (HttpAction, error)

AsHttpAction returns the union data inside the TypedAction as a HttpAction

func (TypedAction) AsIntegrationProxyAction

func (t TypedAction) AsIntegrationProxyAction() (IntegrationProxyAction, error)

AsIntegrationProxyAction returns the union data inside the TypedAction as a IntegrationProxyAction

func (TypedAction) AsIterationAction

func (t TypedAction) AsIterationAction() (IterationAction, error)

AsIterationAction returns the union data inside the TypedAction as a IterationAction

func (TypedAction) AsJWTCreateAction

func (t TypedAction) AsJWTCreateAction() (JWTCreateAction, error)

AsJWTCreateAction returns the union data inside the TypedAction as a JWTCreateAction

func (TypedAction) AsJavaScriptAction

func (t TypedAction) AsJavaScriptAction() (JavaScriptAction, error)

AsJavaScriptAction returns the union data inside the TypedAction as a JavaScriptAction

func (TypedAction) AsJavaScriptReferenceAction

func (t TypedAction) AsJavaScriptReferenceAction() (JavaScriptReferenceAction, error)

AsJavaScriptReferenceAction returns the union data inside the TypedAction as a JavaScriptReferenceAction

func (TypedAction) AsLogAction

func (t TypedAction) AsLogAction() (LogAction, error)

AsLogAction returns the union data inside the TypedAction as a LogAction

func (TypedAction) AsNoopAction

func (t TypedAction) AsNoopAction() (NoopAction, error)

AsNoopAction returns the union data inside the TypedAction as a NoopAction

func (TypedAction) AsPipelineAction

func (t TypedAction) AsPipelineAction() (PipelineAction, error)

AsPipelineAction returns the union data inside the TypedAction as a PipelineAction

func (TypedAction) Discriminator

func (t TypedAction) Discriminator() (string, error)

func (*TypedAction) FromAsyncAction

func (t *TypedAction) FromAsyncAction(v AsyncAction) error

FromAsyncAction overwrites any union data inside the TypedAction as the provided AsyncAction

func (*TypedAction) FromCodeblockAction

func (t *TypedAction) FromCodeblockAction(v CodeblockAction) error

FromCodeblockAction overwrites any union data inside the TypedAction as the provided CodeblockAction

func (*TypedAction) FromCodeblockReferenceAction

func (t *TypedAction) FromCodeblockReferenceAction(v CodeblockReferenceAction) error

FromCodeblockReferenceAction overwrites any union data inside the TypedAction as the provided CodeblockReferenceAction

func (*TypedAction) FromGenericAction

func (t *TypedAction) FromGenericAction(v GenericAction) error

FromGenericAction overwrites any union data inside the TypedAction as the provided GenericAction

func (*TypedAction) FromHttpAction

func (t *TypedAction) FromHttpAction(v HttpAction) error

FromHttpAction overwrites any union data inside the TypedAction as the provided HttpAction

func (*TypedAction) FromIntegrationProxyAction

func (t *TypedAction) FromIntegrationProxyAction(v IntegrationProxyAction) error

FromIntegrationProxyAction overwrites any union data inside the TypedAction as the provided IntegrationProxyAction

func (*TypedAction) FromIterationAction

func (t *TypedAction) FromIterationAction(v IterationAction) error

FromIterationAction overwrites any union data inside the TypedAction as the provided IterationAction

func (*TypedAction) FromJWTCreateAction

func (t *TypedAction) FromJWTCreateAction(v JWTCreateAction) error

FromJWTCreateAction overwrites any union data inside the TypedAction as the provided JWTCreateAction

func (*TypedAction) FromJavaScriptAction

func (t *TypedAction) FromJavaScriptAction(v JavaScriptAction) error

FromJavaScriptAction overwrites any union data inside the TypedAction as the provided JavaScriptAction

func (*TypedAction) FromJavaScriptReferenceAction

func (t *TypedAction) FromJavaScriptReferenceAction(v JavaScriptReferenceAction) error

FromJavaScriptReferenceAction overwrites any union data inside the TypedAction as the provided JavaScriptReferenceAction

func (*TypedAction) FromLogAction

func (t *TypedAction) FromLogAction(v LogAction) error

FromLogAction overwrites any union data inside the TypedAction as the provided LogAction

func (*TypedAction) FromNoopAction

func (t *TypedAction) FromNoopAction(v NoopAction) error

FromNoopAction overwrites any union data inside the TypedAction as the provided NoopAction

func (*TypedAction) FromPipelineAction

func (t *TypedAction) FromPipelineAction(v PipelineAction) error

FromPipelineAction overwrites any union data inside the TypedAction as the provided PipelineAction

func (TypedAction) MarshalJSON

func (t TypedAction) MarshalJSON() ([]byte, error)

func (*TypedAction) MergeAsyncAction

func (t *TypedAction) MergeAsyncAction(v AsyncAction) error

MergeAsyncAction performs a merge with any union data inside the TypedAction, using the provided AsyncAction

func (*TypedAction) MergeCodeblockAction

func (t *TypedAction) MergeCodeblockAction(v CodeblockAction) error

MergeCodeblockAction performs a merge with any union data inside the TypedAction, using the provided CodeblockAction

func (*TypedAction) MergeCodeblockReferenceAction

func (t *TypedAction) MergeCodeblockReferenceAction(v CodeblockReferenceAction) error

MergeCodeblockReferenceAction performs a merge with any union data inside the TypedAction, using the provided CodeblockReferenceAction

func (*TypedAction) MergeGenericAction

func (t *TypedAction) MergeGenericAction(v GenericAction) error

MergeGenericAction performs a merge with any union data inside the TypedAction, using the provided GenericAction

func (*TypedAction) MergeHttpAction

func (t *TypedAction) MergeHttpAction(v HttpAction) error

MergeHttpAction performs a merge with any union data inside the TypedAction, using the provided HttpAction

func (*TypedAction) MergeIntegrationProxyAction

func (t *TypedAction) MergeIntegrationProxyAction(v IntegrationProxyAction) error

MergeIntegrationProxyAction performs a merge with any union data inside the TypedAction, using the provided IntegrationProxyAction

func (*TypedAction) MergeIterationAction

func (t *TypedAction) MergeIterationAction(v IterationAction) error

MergeIterationAction performs a merge with any union data inside the TypedAction, using the provided IterationAction

func (*TypedAction) MergeJWTCreateAction

func (t *TypedAction) MergeJWTCreateAction(v JWTCreateAction) error

MergeJWTCreateAction performs a merge with any union data inside the TypedAction, using the provided JWTCreateAction

func (*TypedAction) MergeJavaScriptAction

func (t *TypedAction) MergeJavaScriptAction(v JavaScriptAction) error

MergeJavaScriptAction performs a merge with any union data inside the TypedAction, using the provided JavaScriptAction

func (*TypedAction) MergeJavaScriptReferenceAction

func (t *TypedAction) MergeJavaScriptReferenceAction(v JavaScriptReferenceAction) error

MergeJavaScriptReferenceAction performs a merge with any union data inside the TypedAction, using the provided JavaScriptReferenceAction

func (*TypedAction) MergeLogAction

func (t *TypedAction) MergeLogAction(v LogAction) error

MergeLogAction performs a merge with any union data inside the TypedAction, using the provided LogAction

func (*TypedAction) MergeNoopAction

func (t *TypedAction) MergeNoopAction(v NoopAction) error

MergeNoopAction performs a merge with any union data inside the TypedAction, using the provided NoopAction

func (*TypedAction) MergePipelineAction

func (t *TypedAction) MergePipelineAction(v PipelineAction) error

MergePipelineAction performs a merge with any union data inside the TypedAction, using the provided PipelineAction

func (*TypedAction) UnmarshalJSON

func (t *TypedAction) UnmarshalJSON(b []byte) error

func (TypedAction) ValueByDiscriminator

func (t TypedAction) ValueByDiscriminator() (interface{}, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL