Documentation
¶
Overview ¶
A Stack Workflow Run refers to a single execution instance of a defined Stack Workflow, where the actions specified in the Stack Workflow configuration are carried out.
For more details, please visit our Workflow Runs [Documentation](https://docs.stackguardian.io/docs/deploy/workflows/workflow_components/run/).
Index ¶
- type Client
- func (c *Client) ApproveStackWorkflowRun(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) error
- func (c *Client) CreateStackWorkflowRun(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowRunsStackCreateResponse, error)
- func (c *Client) ReadStackWorkflowRun(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowRunStackGet, error)
- func (c *Client) ReadStackWorkflowRunLogs(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowRunLogs, 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) ApproveStackWorkflowRun ¶
func (c *Client) ApproveStackWorkflowRun( ctx context.Context, org string, stack string, wf string, wfGrp string, wfRun string, request *sgsdkgo.WorkflowRunApproval, opts ...option.RequestOption, ) error
Provide approval for a Stack Workflow run.
func (*Client) CreateStackWorkflowRun ¶ added in v1.1.0
func (c *Client) CreateStackWorkflowRun( ctx context.Context, org string, stack string, wf string, wfGrp string, request *sgsdkgo.WorkflowRun, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunsStackCreateResponse, error)
Initiate a new workflow run for a specific stack.
func (*Client) ReadStackWorkflowRun ¶
func (c *Client) ReadStackWorkflowRun( ctx context.Context, org string, stack string, wf string, wfGrp string, wfRun string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunStackGet, error)
Retrieve detailed information about a specific stack workflow run.
func (*Client) ReadStackWorkflowRunLogs ¶
func (c *Client) ReadStackWorkflowRunLogs( ctx context.Context, org string, stack string, wf string, wfGrp string, wfRun string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowRunLogs, error)
Retrieve execution logs for a stack 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.
Source Files