workflowdeployments

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) List(ctx context.Context, request *vellumclientgo.WorkflowDeploymentsListRequest, ...) (*vellumclientgo.PaginatedSlimWorkflowDeploymentList, error)
  • func (c *Client) ListWorkflowDeploymentEventExecutions(ctx context.Context, id string, ...) (*vellumclientgo.WorkflowDeploymentEventExecutionsResponse, error)
  • func (c *Client) ListWorkflowReleaseTags(ctx context.Context, id string, ...) (*vellumclientgo.PaginatedWorkflowReleaseTagReadList, error)
  • func (c *Client) Retrieve(ctx context.Context, id string, opts ...option.RequestOption) (*vellumclientgo.WorkflowDeploymentRead, error)
  • func (c *Client) RetrieveWorkflowReleaseTag(ctx context.Context, id string, name string, opts ...option.RequestOption) (*vellumclientgo.WorkflowReleaseTagRead, error)
  • func (c *Client) UpdateWorkflowReleaseTag(ctx context.Context, id string, name string, ...) (*vellumclientgo.WorkflowReleaseTagRead, error)
  • func (c *Client) WorkflowDeploymentEventExecution(ctx context.Context, executionId string, id string, ...) (*vellumclientgo.WorkflowEventExecutionRead, error)
  • func (c *Client) WorkflowDeploymentHistoryItemRetrieve(ctx context.Context, historyIdOrReleaseTag string, id string, ...) (*vellumclientgo.WorkflowDeploymentHistoryItem, error)

Types

type Client

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

func NewClient

func NewClient(opts ...option.RequestOption) *Client

func (*Client) List

func (c *Client) List(
	ctx context.Context,
	request *vellumclientgo.WorkflowDeploymentsListRequest,
	opts ...option.RequestOption,
) (*vellumclientgo.PaginatedSlimWorkflowDeploymentList, error)

Used to list all Workflow Deployments.

func (*Client) ListWorkflowDeploymentEventExecutions

func (c *Client) ListWorkflowDeploymentEventExecutions(
	ctx context.Context,
	id string,
	request *vellumclientgo.ListWorkflowDeploymentEventExecutionsRequest,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowDeploymentEventExecutionsResponse, error)

func (*Client) ListWorkflowReleaseTags

func (c *Client) ListWorkflowReleaseTags(
	ctx context.Context,

	id string,
	request *vellumclientgo.ListWorkflowReleaseTagsRequest,
	opts ...option.RequestOption,
) (*vellumclientgo.PaginatedWorkflowReleaseTagReadList, error)

List Release Tags associated with the specified Workflow Deployment

func (*Client) Retrieve

func (c *Client) Retrieve(
	ctx context.Context,

	id string,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowDeploymentRead, error)

Used to retrieve a workflow deployment given its ID or name.

func (*Client) RetrieveWorkflowReleaseTag

func (c *Client) RetrieveWorkflowReleaseTag(
	ctx context.Context,

	id string,

	name string,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowReleaseTagRead, error)

Retrieve a Workflow Release Tag by tag name, associated with a specified Workflow Deployment.

func (*Client) UpdateWorkflowReleaseTag

func (c *Client) UpdateWorkflowReleaseTag(
	ctx context.Context,

	id string,

	name string,
	request *vellumclientgo.PatchedWorkflowReleaseTagUpdateRequest,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowReleaseTagRead, error)

Updates an existing Release Tag associated with the specified Workflow Deployment.

func (*Client) WorkflowDeploymentEventExecution

func (c *Client) WorkflowDeploymentEventExecution(
	ctx context.Context,
	executionId string,
	id string,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowEventExecutionRead, error)

func (*Client) WorkflowDeploymentHistoryItemRetrieve

func (c *Client) WorkflowDeploymentHistoryItemRetrieve(
	ctx context.Context,

	historyIdOrReleaseTag string,

	id string,
	opts ...option.RequestOption,
) (*vellumclientgo.WorkflowDeploymentHistoryItem, error)

DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the `retrieve_workflow_deployment_release` endpoint instead.