Documentation
¶
Overview ¶
A Workflow run refers to a single execution instance of a defined workflow, where the actions specified in the workflow configuration are carried out.
For more details, visit our [Documentation](https://docs.stackguardian.io/docs/deploy/workflows/workflow_components/run/).
Index ¶
- type Client
- func (c *Client) ApproveWorkflowRun(ctx context.Context, org string, wf string, wfGrp string, wfRun string, ...) (*sgsdkgo.WorkflowRunApprovalResponse, error)
- func (c *Client) CancelWorkflowRun(ctx context.Context, org string, wf string, wfGrp string, wfRun string, ...) (*sgsdkgo.WorkflowRunsCancelResponse, error)
- func (c *Client) CreateWorkflowRun(ctx context.Context, org string, wf string, wfGrp string, ...) (*sgsdkgo.WorkflowRunCreatePatchResponse, error)
- func (c *Client) ListAllWorkflowRuns(ctx context.Context, org string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowRunListAll, error)
- func (c *Client) ReadWorkflowRun(ctx context.Context, org string, wf string, wfGrp string, wfRun string, ...) (*sgsdkgo.GeneratedWorkflowRunsGet, error)
- func (c *Client) ReadWorkflowRunLogs(ctx context.Context, org string, wf string, wfGrp string, wfRun string, ...) (*sgsdkgo.GeneratedWorkflowRunLogs, error)
- func (c *Client) UpdateWorkflowRun(ctx context.Context, org string, wf string, wfGrp string, wfRun string, ...) (*sgsdkgo.GeneratedWorkfkowRunsUpdateResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewClient ¶
func NewClient(opts ...option.RequestOption) *Client
func (*Client) ApproveWorkflowRun ¶
func (c *Client) ApproveWorkflowRun( ctx context.Context, org string, wf string, wfGrp string, wfRun string, request *sgsdkgo.WorkflowRunApproval, opts ...option.RequestOption, ) (*sgsdkgo.WorkflowRunApprovalResponse, error)
Provide approval for a Workflow Run.
func (*Client) CancelWorkflowRun ¶
func (c *Client) CancelWorkflowRun( ctx context.Context, org string, wf string, wfGrp string, wfRun string, opts ...option.RequestOption, ) (*sgsdkgo.WorkflowRunsCancelResponse, error)
Cancel a running or queued workflow run.
func (*Client) CreateWorkflowRun ¶
func (c *Client) CreateWorkflowRun( ctx context.Context, org string, wf string, wfGrp string, request *sgsdkgo.WorkflowRun, opts ...option.RequestOption, ) (*sgsdkgo.WorkflowRunCreatePatchResponse, error)
Initiate a new workflow run.
func (*Client) ListAllWorkflowRuns ¶
func (c *Client) ListAllWorkflowRuns( ctx context.Context, org string, wf string, wfGrp string, request *sgsdkgo.ListAllWorkflowRunsRequest, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunListAll, error)
Retrieve a list of all workflow runs. Supports Pagination and Filtering using query parameters.
func (*Client) ReadWorkflowRun ¶
func (c *Client) ReadWorkflowRun( ctx context.Context, org string, wf string, wfGrp string, wfRun string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunsGet, error)
Retrieve the details of an existing workflow run.
func (*Client) ReadWorkflowRunLogs ¶
func (c *Client) ReadWorkflowRunLogs( ctx context.Context, org string, wf string, wfGrp string, wfRun string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunLogs, error)
Retrieve execution logs for a workflow run.
This endpoint returns a signed URL that can be used to fetch the logs in `text/plain` format. This signed URL is valid for 60 minutes. After expiration, you can request a new signed URL by calling this endpoint again.
func (*Client) UpdateWorkflowRun ¶
func (c *Client) UpdateWorkflowRun( ctx context.Context, org string, wf string, wfGrp string, wfRun string, request *sgsdkgo.PatchedWorkflowRun, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkfkowRunsUpdateResponse, error)
Update the details of a workflow run.
Source Files