client

package
v1.3.9 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 25 Imported by: 7

Documentation

Overview

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

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

func NewAPIClient 

func NewAPIClient(
	authenticationSettings *settings.AuthenticationSettings,
	httpSettings *settings.HttpSettings,
) *APIClient

func NewAPIClientWithTokenExpiration added in v1.2.19 

func NewAPIClientWithTokenExpiration(
	authenticationSettings *settings.AuthenticationSettings,
	httpSettings *settings.HttpSettings,
	tokenExpiration *authentication.TokenExpiration,
) *APIClient

type EventResourceApiGetEventHandlersForEventOpts 

type EventResourceApiGetEventHandlersForEventOpts struct {
	ActiveOnly optional.Bool
}

type EventResourceApiService 

type EventResourceApiService struct {
	*APIClient
}

func (*EventResourceApiService) AddEventHandler 

func (a *EventResourceApiService) AddEventHandler(ctx context.Context, body model.EventHandler) (*http.Response, error)

EventResourceApiService Add a new event handler.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*EventResourceApiService) DeleteQueueConfig added in v1.2.13 

func (a *EventResourceApiService) DeleteQueueConfig(ctx context.Context, queueType string, queueName string) (*http.Response, error)

EventResourceApiService Delete queue config by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queueType
  • @param queueName

func (*EventResourceApiService) GetEventHandlers 

func (a *EventResourceApiService) GetEventHandlers(ctx context.Context) ([]model.EventHandler, *http.Response, error)

EventResourceApiService Get all the event handlers

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []model.EventHandler

func (*EventResourceApiService) GetEventHandlersForEvent 

func (a *EventResourceApiService) GetEventHandlersForEvent(ctx context.Context, event string, localVarOptionals *EventResourceApiGetEventHandlersForEventOpts) ([]model.EventHandler, *http.Response, error)

func (*EventResourceApiService) GetQueueConfig added in v1.2.13 

func (a *EventResourceApiService) GetQueueConfig(ctx context.Context, queueType string, queueName string) (map[string]interface{}, *http.Response, error)

EventResourceApiService Get queue config by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param queueType
  • @param queueName

@return map[string]interface{}

func (*EventResourceApiService) GetQueueNames added in v1.2.13 

func (a *EventResourceApiService) GetQueueNames(ctx context.Context) (map[string]string, *http.Response, error)

EventResourceApiService Get all queue configs

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]string

func (*EventResourceApiService) PutQueueConfig added in v1.2.13 

func (a *EventResourceApiService) PutQueueConfig(ctx context.Context, body string, queueType string, queueName string) (*http.Response, error)

EventResourceApiService Create or update queue config by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param queueType
  • @param queueName

func (*EventResourceApiService) RemoveEventHandlerStatus 

func (a *EventResourceApiService) RemoveEventHandlerStatus(ctx context.Context, name string) (*http.Response, error)

EventResourceApiService Remove an event handler

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

func (*EventResourceApiService) UpdateEventHandler 

func (a *EventResourceApiService) UpdateEventHandler(ctx context.Context, body model.EventHandler) (*http.Response, error)

EventResourceApiService Update an existing event handler.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

type GenericSwaggerError 

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

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body 

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error 

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model 

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type GetAllSchedulesOpts added in v1.3.2 

type GetAllSchedulesOpts struct {
	WorkflowName optional.String
}

type HealthCheckResourceApiService 

type HealthCheckResourceApiService struct {
	*APIClient
}

func (*HealthCheckResourceApiService) DoCheck 

func (a *HealthCheckResourceApiService) DoCheck(ctx context.Context) (model.HealthCheckStatus, *http.Response, error)

HealthCheckResourceApiService

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return http_model.HealthCheckStatus

type HttpRequester added in v1.2.19 

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

func NewHttpRequester added in v1.2.19 

func NewHttpRequester(authenticationSettings *settings.AuthenticationSettings, httpSettings *settings.HttpSettings, httpClient *http.Client, tokenExpiration *authentication.TokenExpiration) *HttpRequester

type MetadataResourceApiGetOpts 

type MetadataResourceApiGetOpts struct {
	Version optional.Int32
}

type MetadataResourceApiService 

type MetadataResourceApiService struct {
	*APIClient
}

func (*MetadataResourceApiService) Get 

func (a *MetadataResourceApiService) Get(ctx context.Context, name string, localVarOptionals *MetadataResourceApiGetOpts) (model.WorkflowDef, *http.Response, error)

func (*MetadataResourceApiService) GetAll 

func (a *MetadataResourceApiService) GetAll(ctx context.Context) ([]model.WorkflowDef, *http.Response, error)

MetadataResourceApiService Retrieves all workflow definition along with blueprint

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []http_model.WorkflowDef

func (*MetadataResourceApiService) GetTagsForTaskDef added in v1.3.5 

func (a *MetadataResourceApiService) GetTagsForTaskDef(ctx context.Context, tasktype string) ([]model.MetadataTag, error)

func (*MetadataResourceApiService) GetTagsForWorkflowDef added in v1.3.5 

func (a *MetadataResourceApiService) GetTagsForWorkflowDef(ctx context.Context, name string) ([]model.MetadataTag, error)

func (*MetadataResourceApiService) GetTaskDef 

func (a *MetadataResourceApiService) GetTaskDef(ctx context.Context, tasktype string) (model.TaskDef, *http.Response, error)

MetadataResourceApiService Gets the task definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tasktype

@return http_model.TaskDef

func (*MetadataResourceApiService) GetTaskDefs 

func (a *MetadataResourceApiService) GetTaskDefs(ctx context.Context) ([]model.TaskDef, *http.Response, error)

MetadataResourceApiService Gets all task definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []http_model.TaskDef

func (*MetadataResourceApiService) RegisterTaskDef 

func (a *MetadataResourceApiService) RegisterTaskDef(ctx context.Context, body []model.TaskDef) (*http.Response, error)

MetadataResourceApiService Create new task definition(s)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) RegisterTaskDefWithTags added in v1.3.5 

func (a *MetadataResourceApiService) RegisterTaskDefWithTags(ctx context.Context, body model.TaskDef, tags []model.MetadataTag) (*http.Response, error)

MetadataResourceApiService Create new task definition with tags

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body model.TaskDef
  • @param tags []model.MetadataTag

func (*MetadataResourceApiService) RegisterWorkflowDef 

func (a *MetadataResourceApiService) RegisterWorkflowDef(ctx context.Context, overwrite bool, body model.WorkflowDef) (*http.Response, error)

MetadataResourceApiService Create a new workflow definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) RegisterWorkflowDefWithTags added in v1.3.5 

func (a *MetadataResourceApiService) RegisterWorkflowDefWithTags(ctx context.Context, overwrite bool, body model.WorkflowDef, tags []model.MetadataTag) (*http.Response, error)

MetadataResourceApiService Create a new workflow definition with tags

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) UnregisterTaskDef 

func (a *MetadataResourceApiService) UnregisterTaskDef(ctx context.Context, tasktype string) (*http.Response, error)

MetadataResourceApiService Remove a task definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param tasktype

func (*MetadataResourceApiService) UnregisterWorkflowDef 

func (a *MetadataResourceApiService) UnregisterWorkflowDef(ctx context.Context, name string, version int32) (*http.Response, error)

MetadataResourceApiService Removes workflow definition. It does not remove workflows associated with the definition.

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name
  • @param version

func (*MetadataResourceApiService) Update 

func (a *MetadataResourceApiService) Update(ctx context.Context, body []model.WorkflowDef) (*http.Response, error)

MetadataResourceApiService Create or update workflow definition

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) UpdateTaskDef 

func (a *MetadataResourceApiService) UpdateTaskDef(ctx context.Context, body model.TaskDef) (*http.Response, error)

MetadataResourceApiService Update an existing task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) UpdateTaskDefWithTags added in v1.3.5 

func (a *MetadataResourceApiService) UpdateTaskDefWithTags(ctx context.Context, body model.TaskDef, tags []model.MetadataTag, overwriteTags bool) (*http.Response, error)

MetadataResourceApiService Update an existing task along with tags

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*MetadataResourceApiService) UpdateWorkflowDefWithTags added in v1.3.5 

func (a *MetadataResourceApiService) UpdateWorkflowDefWithTags(ctx context.Context, body model.WorkflowDef, tags []model.MetadataTag, overwriteTags bool) (*http.Response, error)

MetadataResourceApiService Create or update workflow definition along with tags

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

type NextFewSchedulesOpts added in v1.3.2 

type NextFewSchedulesOpts struct {
	ScheduleStartTime optional.Int64
	ScheduleEndTime   optional.Int64
	Limit             optional.Int32
}

type SchedulerClient added in v1.3.2 

type SchedulerClient interface {
	// DeleteSchedule Deletes the schedule given the name
	DeleteSchedule(ctx context.Context, name string) (*http.Response, error)

	//DeleteTagForSchedule Remove the tags from the schedule
	DeleteTagForSchedule(ctx context.Context, tags []model.Tag, name string) (*http.Response, error)

	//GetAllSchedules Retrieve all the schedules
	GetAllSchedules(ctx context.Context, localVarOptionals *GetAllSchedulesOpts) ([]model.WorkflowSchedule, *http.Response, error)

	//GetNextFewSchedules given the cron expression retrieves the next few schedules.  Useful for testing
	GetNextFewSchedules(ctx context.Context, cronExpression string, localVarOptionals *NextFewSchedulesOpts) ([]int64, *http.Response, error)

	//GetSchedule Retrieve schedule definition given the name
	GetSchedule(ctx context.Context, name string) (model.WorkflowSchedule, *http.Response, error)

	//GetTagsForSchedule get tags associated with the schedule
	GetTagsForSchedule(ctx context.Context, name string) ([]model.Tag, *http.Response, error)

	//PauseAllSchedules WARNING: pauses ALL the schedules in the system.  Use with caution!
	PauseAllSchedules(ctx context.Context) (map[string]interface{}, *http.Response, error)

	//PauseSchedule pause the schedule by name
	PauseSchedule(ctx context.Context, name string) (*http.Response, error)

	//AddTagForSchedule Adds tags to the schedule
	AddTagForSchedule(ctx context.Context, tags []model.Tag, name string) (*http.Response, error)

	//ResumeAllSchedules Resume ALL the schedule.  WARNING: use with caution!
	ResumeAllSchedules(ctx context.Context) (map[string]interface{}, *http.Response, error)

	//ResumeSchedule Resumes the schedule by name
	ResumeSchedule(ctx context.Context, name string) (*http.Response, error)

	//SaveSchedule Upsert a new schedule
	SaveSchedule(ctx context.Context, body model.SaveScheduleRequest) (*http.Response, error)

	//Search Find all the executions for the given schedule
	Search(ctx context.Context, localVarOptionals *SchedulerSearchOpts) (model.SearchResultWorkflowSchedule, *http.Response, error)
}

SchedulerClient manage workflow schedules

func GetSchedulerService added in v1.3.2 

func GetSchedulerService(client *APIClient) SchedulerClient

type SchedulerResourceApiService added in v1.3.2 

type SchedulerResourceApiService struct {
	*APIClient
}

func (*SchedulerResourceApiService) AddTagForSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) AddTagForSchedule(ctx context.Context, body []model.Tag, name string) (*http.Response, error)

func (*SchedulerResourceApiService) DeleteSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) DeleteSchedule(ctx context.Context, name string) (*http.Response, error)

func (*SchedulerResourceApiService) DeleteTagForSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) DeleteTagForSchedule(ctx context.Context, tags []model.Tag, name string) (*http.Response, error)

func (*SchedulerResourceApiService) GetAllSchedules added in v1.3.2 

func (a *SchedulerResourceApiService) GetAllSchedules(ctx context.Context, localVarOptionals *GetAllSchedulesOpts) ([]model.WorkflowSchedule, *http.Response, error)

func (*SchedulerResourceApiService) GetNextFewSchedules added in v1.3.2 

func (a *SchedulerResourceApiService) GetNextFewSchedules(ctx context.Context, cronExpression string, localVarOptionals *NextFewSchedulesOpts) ([]int64, *http.Response, error)

func (*SchedulerResourceApiService) GetSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) GetSchedule(ctx context.Context, name string) (model.WorkflowSchedule, *http.Response, error)

SchedulerResourceApiService Get an existing workflow schedule by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return WorkflowSchedule

func (*SchedulerResourceApiService) GetTagsForSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) GetTagsForSchedule(ctx context.Context, name string) ([]model.Tag, *http.Response, error)

SchedulerResourceApiService Get tags by schedule

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return []TagObject

func (*SchedulerResourceApiService) PauseAllSchedules added in v1.3.2 

func (a *SchedulerResourceApiService) PauseAllSchedules(ctx context.Context) (map[string]interface{}, *http.Response, error)

SchedulerResourceApiService Pause all scheduling in a single conductor server instance (for debugging only)

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]interface{}

func (*SchedulerResourceApiService) PauseSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) PauseSchedule(ctx context.Context, name string) (*http.Response, error)

SchedulerResourceApiService Pauses an existing schedule by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

func (*SchedulerResourceApiService) ResumeAllSchedules added in v1.3.2 

func (a *SchedulerResourceApiService) ResumeAllSchedules(ctx context.Context) (map[string]interface{}, *http.Response, error)

SchedulerResourceApiService Resume all scheduling

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]interface{}

func (*SchedulerResourceApiService) ResumeSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) ResumeSchedule(ctx context.Context, name string) (*http.Response, error)

SchedulerResourceApiService Resume a paused schedule by name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

func (*SchedulerResourceApiService) SaveSchedule added in v1.3.2 

func (a *SchedulerResourceApiService) SaveSchedule(ctx context.Context, body model.SaveScheduleRequest) (*http.Response, error)

SchedulerResourceApiService Create or update a schedule for a specified workflow with a corresponding start workflow request

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

func (*SchedulerResourceApiService) Search added in v1.3.2 

func (a *SchedulerResourceApiService) Search(ctx context.Context, localVarOptionals *SchedulerSearchOpts) (model.SearchResultWorkflowSchedule, *http.Response, error)

type SchedulerSearchOpts added in v1.3.2 

type SchedulerSearchOpts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type TagsApiService added in v1.3.5 

type TagsApiService struct {
	*APIClient
}

func (*TagsApiService) AddTaskTag added in v1.3.5 

func (a *TagsApiService) AddTaskTag(ctx context.Context, body model.TagObject, taskName string) (interface{}, *http.Response, error)

TagsApiService Adds the tag to the task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param taskName

@return interface{}

func (*TagsApiService) AddWorkflowTag added in v1.3.5 

func (a *TagsApiService) AddWorkflowTag(ctx context.Context, body model.TagObject, name string) (interface{}, *http.Response, error)

TagsApiService Adds the tag to the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param name

@return interface{}

func (*TagsApiService) DeleteTaskTag added in v1.3.5 

func (a *TagsApiService) DeleteTaskTag(ctx context.Context, body model.TagString, taskName string) (interface{}, *http.Response, error)

TagsApiService Removes the tag of the task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param taskName

@return interface{}

func (*TagsApiService) DeleteWorkflowTag added in v1.3.5 

func (a *TagsApiService) DeleteWorkflowTag(ctx context.Context, body model.TagObject, name string) (interface{}, *http.Response, error)

TagsApiService Removes the tag of the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param name

@return interface{}

func (*TagsApiService) GetTags1 added in v1.3.5 

func (a *TagsApiService) GetTags1(ctx context.Context) ([]model.TagObject, *http.Response, error)

TagsApiService List all tags

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []model.TagObject

func (*TagsApiService) GetTaskTags added in v1.3.5 

func (a *TagsApiService) GetTaskTags(ctx context.Context, taskName string) ([]model.TagObject, *http.Response, error)

TagsApiService Returns all the tags of the task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskName

@return []model.TagObject

func (*TagsApiService) GetWorkflowTags added in v1.3.5 

func (a *TagsApiService) GetWorkflowTags(ctx context.Context, name string) ([]model.TagObject, *http.Response, error)

TagsApiService Returns all the tags of the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param name

@return []model.TagObject

func (*TagsApiService) SetTaskTags added in v1.3.5 

func (a *TagsApiService) SetTaskTags(ctx context.Context, body []model.TagObject, taskName string) (interface{}, *http.Response, error)

TagsApiService Adds the tag to the task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param taskName

@return interface{}

func (*TagsApiService) SetWorkflowTags added in v1.3.5 

func (a *TagsApiService) SetWorkflowTags(ctx context.Context, body []model.TagObject, name string) (interface{}, *http.Response, error)

TagsApiService Set the tags of the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param name

@return interface{}

type TaskResourceApiBatchPollOpts 

type TaskResourceApiBatchPollOpts struct {
	Workerid optional.String
	Domain   optional.String
	Count    optional.Int32
	Timeout  optional.Int32
}

type TaskResourceApiPollOpts 

type TaskResourceApiPollOpts struct {
	Workerid optional.String
	Domain   optional.String
}

type TaskResourceApiSearch1Opts 

type TaskResourceApiSearch1Opts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type TaskResourceApiSearchV21Opts 

type TaskResourceApiSearchV21Opts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type TaskResourceApiService 

type TaskResourceApiService struct {
	*APIClient
}

func (*TaskResourceApiService) All 

func (a *TaskResourceApiService) All(ctx context.Context) (map[string]int64, *http.Response, error)

TaskResourceApiService Get the details about each queue

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]int64

func (*TaskResourceApiService) AllVerbose 

func (a *TaskResourceApiService) AllVerbose(ctx context.Context) (map[string]map[string]map[string]int64, *http.Response, error)

TaskResourceApiService Get the details about each queue

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return map[string]map[string]map[string]int64

func (*TaskResourceApiService) BatchPoll 

func (a *TaskResourceApiService) BatchPoll(ctx context.Context, tasktype string, localVarOptionals *TaskResourceApiBatchPollOpts) ([]model.Task, *http.Response, error)

func (*TaskResourceApiService) GetAllPollData 

func (a *TaskResourceApiService) GetAllPollData(ctx context.Context) ([]model.PollData, *http.Response, error)

TaskResourceApiService Get the last poll data for all task types

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return []PollData

func (*TaskResourceApiService) GetExternalStorageLocation1 

func (a *TaskResourceApiService) GetExternalStorageLocation1(ctx context.Context, path string, operation string, payloadType string) (model.ExternalStorageLocation, *http.Response, error)

TaskResourceApiService Get the external uri where the task payload is to be stored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param operation
  • @param payloadType

@return ExternalStorageLocation

func (*TaskResourceApiService) GetPollData 

func (a *TaskResourceApiService) GetPollData(ctx context.Context, taskType string) ([]model.PollData, *http.Response, error)

TaskResourceApiService Get the last poll data for a given task type

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskType

@return []PollData

func (*TaskResourceApiService) GetTask 

func (a *TaskResourceApiService) GetTask(ctx context.Context, taskId string) (model.Task, *http.Response, error)

TaskResourceApiService Get task by Id

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

@return Task

func (*TaskResourceApiService) GetTaskLogs 

func (a *TaskResourceApiService) GetTaskLogs(ctx context.Context, taskId string) ([]model.TaskExecLog, *http.Response, error)

TaskResourceApiService Get Task Execution Logs

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskId

@return []TaskExecLog

func (*TaskResourceApiService) Log 

func (a *TaskResourceApiService) Log(ctx context.Context, body string, taskId string) (*http.Response, error)

TaskResourceApiService Log Task Execution Details

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param taskId

func (*TaskResourceApiService) Poll 

func (a *TaskResourceApiService) Poll(ctx context.Context, tasktype string, localVarOptionals *TaskResourceApiPollOpts) (model.Task, *http.Response, error)

func (*TaskResourceApiService) RequeuePendingTask 

func (a *TaskResourceApiService) RequeuePendingTask(ctx context.Context, taskType string) (string, *http.Response, error)

TaskResourceApiService Requeue pending tasks

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param taskType

@return string

func (*TaskResourceApiService) Search1 

func (a *TaskResourceApiService) Search1(ctx context.Context, localVarOptionals *TaskResourceApiSearch1Opts) (model.SearchResultTaskSummary, *http.Response, error)

func (*TaskResourceApiService) SearchV21 

func (a *TaskResourceApiService) SearchV21(ctx context.Context, localVarOptionals *TaskResourceApiSearchV21Opts) (model.SearchResultTask, *http.Response, error)

func (*TaskResourceApiService) Size 

func (a *TaskResourceApiService) Size(ctx context.Context, localVarOptionals *TaskResourceApiSizeOpts) (map[string]int32, *http.Response, error)

func (*TaskResourceApiService) UpdateTask 

func (a *TaskResourceApiService) UpdateTask(ctx context.Context, taskResult *model.TaskResult) (string, *http.Response, error)

TaskResourceApiService Update a task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return string

func (*TaskResourceApiService) UpdateTaskByRefName 

func (a *TaskResourceApiService) UpdateTaskByRefName(ctx context.Context, body map[string]interface{}, workflowId string, taskRefName string, status string) (string, *http.Response, error)

TaskResourceApiService Update a task By Ref Name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param workflowId
  • @param taskRefName
  • @param status

@return string

func (*TaskResourceApiService) UpdateTaskByRefNameWithWorkerId added in v1.2.23 

func (a *TaskResourceApiService) UpdateTaskByRefNameWithWorkerId(ctx context.Context, body map[string]interface{}, workflowId string, taskRefName string, status string, workerId optional.String) (string, *http.Response, error)

TaskResourceApiService Update a task By Ref Name

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param workflowId
  • @param taskRefName
  • @param status
  • @param workerId

@return string

type TaskResourceApiSizeOpts 

type TaskResourceApiSizeOpts struct {
	TaskType optional.Interface
}

type WorkflowBulkResourceApiRestart1Opts 

type WorkflowBulkResourceApiRestart1Opts struct {
	UseLatestDefinitions optional.Bool
}

type WorkflowBulkResourceApiService 

type WorkflowBulkResourceApiService struct {
	*APIClient
}

func (*WorkflowBulkResourceApiService) PauseWorkflow1 

func (a *WorkflowBulkResourceApiService) PauseWorkflow1(ctx context.Context, body []string) (model.BulkResponse, *http.Response, error)

WorkflowBulkResourceApiService Pause the list of workflows

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return http_model.BulkResponse

func (*WorkflowBulkResourceApiService) Restart1 

func (a *WorkflowBulkResourceApiService) Restart1(ctx context.Context, body []string, localVarOptionals *WorkflowBulkResourceApiRestart1Opts) (model.BulkResponse, *http.Response, error)

func (*WorkflowBulkResourceApiService) ResumeWorkflow1 

func (a *WorkflowBulkResourceApiService) ResumeWorkflow1(ctx context.Context, body []string) (model.BulkResponse, *http.Response, error)

WorkflowBulkResourceApiService Resume the list of workflows

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return http_model.BulkResponse

func (*WorkflowBulkResourceApiService) Retry1 

func (a *WorkflowBulkResourceApiService) Retry1(ctx context.Context, body []string) (model.BulkResponse, *http.Response, error)

WorkflowBulkResourceApiService Retry the last failed task for each workflow from the list

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return http_model.BulkResponse

func (*WorkflowBulkResourceApiService) Terminate 

func (a *WorkflowBulkResourceApiService) Terminate(ctx context.Context, body []string, localVarOptionals *WorkflowBulkResourceApiTerminateOpts) (model.BulkResponse, *http.Response, error)

type WorkflowBulkResourceApiTerminateOpts 

type WorkflowBulkResourceApiTerminateOpts struct {
	Reason                 optional.String
	TriggerFailureWorkflow optional.Bool
}

type WorkflowResourceApiDeleteOpts 

type WorkflowResourceApiDeleteOpts struct {
	ArchiveWorkflow optional.Bool
}

type WorkflowResourceApiGetExecutionStatusOpts 

type WorkflowResourceApiGetExecutionStatusOpts struct {
	IncludeTasks optional.Bool
}

type WorkflowResourceApiGetRunningWorkflowOpts 

type WorkflowResourceApiGetRunningWorkflowOpts struct {
	Version   optional.Int32
	StartTime optional.Int64
	EndTime   optional.Int64
}

type WorkflowResourceApiGetWorkflows1Opts 

type WorkflowResourceApiGetWorkflows1Opts struct {
	IncludeClosed optional.Bool
	IncludeTasks  optional.Bool
}

type WorkflowResourceApiGetWorkflowsOpts 

type WorkflowResourceApiGetWorkflowsOpts struct {
	IncludeClosed optional.Bool
	IncludeTasks  optional.Bool
}

type WorkflowResourceApiRestartOpts 

type WorkflowResourceApiRestartOpts struct {
	UseLatestDefinitions optional.Bool
}

type WorkflowResourceApiRetryOpts 

type WorkflowResourceApiRetryOpts struct {
	ResumeSubworkflowTasks optional.Bool
}

type WorkflowResourceApiSearchOpts 

type WorkflowResourceApiSearchOpts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type WorkflowResourceApiSearchV2Opts 

type WorkflowResourceApiSearchV2Opts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type WorkflowResourceApiSearchWorkflowsByTasksOpts 

type WorkflowResourceApiSearchWorkflowsByTasksOpts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type WorkflowResourceApiSearchWorkflowsByTasksV2Opts 

type WorkflowResourceApiSearchWorkflowsByTasksV2Opts struct {
	Start    optional.Int32
	Size     optional.Int32
	Sort     optional.String
	FreeText optional.String
	Query    optional.String
}

type WorkflowResourceApiService 

type WorkflowResourceApiService struct {
	*APIClient
}

func (*WorkflowResourceApiService) Decide 

func (a *WorkflowResourceApiService) Decide(ctx context.Context, workflowId string) (*http.Response, error)

WorkflowResourceApiService Starts the decision task for a workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowId

func (*WorkflowResourceApiService) Delete 

func (a *WorkflowResourceApiService) Delete(ctx context.Context, workflowId string, localVarOptionals *WorkflowResourceApiDeleteOpts) (*http.Response, error)

func (*WorkflowResourceApiService) ExecuteWorkflow added in v1.2.15 

func (a *WorkflowResourceApiService) ExecuteWorkflow(ctx context.Context, body model.StartWorkflowRequest, requestId string, name string, version int32, waitUntilTask string) (model.WorkflowRun, *http.Response, error)

func (*WorkflowResourceApiService) GetExecutionStatus 

func (a *WorkflowResourceApiService) GetExecutionStatus(ctx context.Context, workflowId string, localVarOptionals *WorkflowResourceApiGetExecutionStatusOpts) (model.Workflow, *http.Response, error)

func (*WorkflowResourceApiService) GetExternalStorageLocation 

func (a *WorkflowResourceApiService) GetExternalStorageLocation(ctx context.Context, path string, operation string, payloadType string) (model.ExternalStorageLocation, *http.Response, error)

WorkflowResourceApiService Get the uri and path of the external storage where the workflow payload is to be stored

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param path
  • @param operation
  • @param payloadType

@return http_model.ExternalStorageLocation

func (*WorkflowResourceApiService) GetRunningWorkflow 

func (a *WorkflowResourceApiService) GetRunningWorkflow(ctx context.Context, name string, localVarOptionals *WorkflowResourceApiGetRunningWorkflowOpts) ([]string, *http.Response, error)

func (*WorkflowResourceApiService) GetWorkflowState 

func (a *WorkflowResourceApiService) GetWorkflowState(ctx context.Context, workflowId string, includeOutput bool, includeVariables bool) (model.WorkflowState, *http.Response, error)

func (*WorkflowResourceApiService) GetWorkflows 

func (a *WorkflowResourceApiService) GetWorkflows(ctx context.Context, body []string, name string, localVarOptionals *WorkflowResourceApiGetWorkflowsOpts) (map[string][]model.Workflow, *http.Response, error)

func (*WorkflowResourceApiService) GetWorkflows1 

func (a *WorkflowResourceApiService) GetWorkflows1(ctx context.Context, name string, correlationId string, localVarOptionals *WorkflowResourceApiGetWorkflows1Opts) ([]model.Workflow, *http.Response, error)

func (*WorkflowResourceApiService) GetWorkflowsBatch added in v1.2.17 

func (a *WorkflowResourceApiService) GetWorkflowsBatch(ctx context.Context, body map[string][]string, localVarOptionals *WorkflowResourceApiGetWorkflowsOpts) (map[string][]model.Workflow, *http.Response, error)

func (*WorkflowResourceApiService) PauseWorkflow 

func (a *WorkflowResourceApiService) PauseWorkflow(ctx context.Context, workflowId string) (*http.Response, error)

WorkflowResourceApiService Pauses the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowId

func (*WorkflowResourceApiService) Rerun 

func (a *WorkflowResourceApiService) Rerun(ctx context.Context, body model.RerunWorkflowRequest, workflowId string) (string, *http.Response, error)

WorkflowResourceApiService Reruns the workflow from a specific task

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body
  • @param workflowId

@return string

func (*WorkflowResourceApiService) ResetWorkflow 

func (a *WorkflowResourceApiService) ResetWorkflow(ctx context.Context, workflowId string) (*http.Response, error)

WorkflowResourceApiService Resets callback times of all non-terminal SIMPLE tasks to 0

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowId

func (*WorkflowResourceApiService) Restart 

func (a *WorkflowResourceApiService) Restart(ctx context.Context, workflowId string, localVarOptionals *WorkflowResourceApiRestartOpts) (*http.Response, error)

func (*WorkflowResourceApiService) ResumeWorkflow 

func (a *WorkflowResourceApiService) ResumeWorkflow(ctx context.Context, workflowId string) (*http.Response, error)

WorkflowResourceApiService Resumes the workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowId

func (*WorkflowResourceApiService) Retry 

func (a *WorkflowResourceApiService) Retry(ctx context.Context, workflowId string, localVarOptionals *WorkflowResourceApiRetryOpts) (*http.Response, error)

func (*WorkflowResourceApiService) Search 

func (a *WorkflowResourceApiService) Search(ctx context.Context, localVarOptionals *WorkflowResourceApiSearchOpts) (model.SearchResultWorkflowSummary, *http.Response, error)

func (*WorkflowResourceApiService) SearchV2 

func (a *WorkflowResourceApiService) SearchV2(ctx context.Context, localVarOptionals *WorkflowResourceApiSearchV2Opts) (model.SearchResultWorkflow, *http.Response, error)

func (*WorkflowResourceApiService) SearchWorkflowsByTasks 

func (a *WorkflowResourceApiService) SearchWorkflowsByTasks(ctx context.Context, localVarOptionals *WorkflowResourceApiSearchWorkflowsByTasksOpts) (model.SearchResultWorkflowSummary, *http.Response, error)

func (*WorkflowResourceApiService) SearchWorkflowsByTasksV2 

func (a *WorkflowResourceApiService) SearchWorkflowsByTasksV2(ctx context.Context, localVarOptionals *WorkflowResourceApiSearchWorkflowsByTasksV2Opts) (model.SearchResultWorkflow, *http.Response, error)

func (*WorkflowResourceApiService) SkipTaskFromWorkflow 

func (a *WorkflowResourceApiService) SkipTaskFromWorkflow(ctx context.Context, workflowId string, taskReferenceName string, skipTaskRequest model.SkipTaskRequest) (*http.Response, error)

WorkflowResourceApiService Skips a given task from a current running workflow

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param workflowId
  • @param taskReferenceName
  • @param skipTaskRequest

func (*WorkflowResourceApiService) StartWorkflow 

func (a *WorkflowResourceApiService) StartWorkflow(ctx context.Context, body map[string]interface{}, name string, localVarOptionals *WorkflowResourceApiStartWorkflowOpts) (string, *http.Response, error)

func (*WorkflowResourceApiService) StartWorkflowWithRequest 

func (a *WorkflowResourceApiService) StartWorkflowWithRequest(ctx context.Context, body model.StartWorkflowRequest) (string, *http.Response, error)

WorkflowResourceApiService Start a new workflow with http_model.StartWorkflowRequest, which allows task to be executed in a domain

  • @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param body

@return string

func (*WorkflowResourceApiService) Terminate 

func (a *WorkflowResourceApiService) Terminate(ctx context.Context, workflowId string, localVarOptionals *WorkflowResourceApiTerminateOpts) (*http.Response, error)

type WorkflowResourceApiStartWorkflowOpts 

type WorkflowResourceApiStartWorkflowOpts struct {
	Version       optional.Int32
	CorrelationId optional.String
	Priority      optional.Int32
}

type WorkflowResourceApiTerminateOpts 

type WorkflowResourceApiTerminateOpts struct {
	Reason                 optional.String
	TriggerFailureWorkflow optional.Bool
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.