Documentation
¶
Overview ¶
A Stack Workflow refers to a Workflow that is part of a Stack. A Stack Workflow is the same as an individual Workflow but is contained within a Stack.
For more details, please visit our workflow [Documentaion](https://docs.stackguardian.io/docs/deploy/workflows/overview/).
Index ¶
- type Client
- func (c *Client) DeleteStackWorkflow(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) error
- func (c *Client) GetSignedUrlToUploadTfstateFileForStackWorkflow(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowUploadUrlResponse, error)
- func (c *Client) ListAllStackWorkflows(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.WorkflowsListAll, error)
- func (c *Client) ListAllStackWorkflowsArtifacts(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowListAllArtifactsResponse, error)
- func (c *Client) ReadStackWorkflow(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.WorkflowGetResponse, error)
- func (c *Client) StackWorkflowOutputs(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowOutputsResponse, error)
- func (c *Client) UpdateStackWorkflow(ctx context.Context, org string, stack string, wf string, wfGrp string, ...) (*sgsdkgo.GeneratedWorkflowUpdateResponse, 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) DeleteStackWorkflow ¶
func (c *Client) DeleteStackWorkflow( ctx context.Context, org string, stack string, wf string, wfGrp string, opts ...option.RequestOption, ) error
Delete an existing workflow in a stack.
func (*Client) GetSignedUrlToUploadTfstateFileForStackWorkflow ¶ added in v1.2.0
func (c *Client) GetSignedUrlToUploadTfstateFileForStackWorkflow( ctx context.Context, org string, stack string, wf string, wfGrp string, request *sgsdkgo.GetSignedUrlToUploadTfstateFileForStackWorkflowRequest, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowUploadUrlResponse, error)
This endpoint returns a signed URL to upload a tfstate file for a Stack Workflow. The state file can be uploaded by performing a PUT operation on the returned URL. The URL is valid for 5 minutes.
You can use the following curl command as an example on how to upload the state file using the returned URL:
curl -v -i -s -X PUT \
-H "Content-Type: application/json" \
-T "<your_tf_state_file>.json" \
"https://<your-returned-signed-url>"
func (*Client) ListAllStackWorkflows ¶
func (c *Client) ListAllStackWorkflows( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.ListAllStackWorkflowsRequest, opts ...option.RequestOption, ) (*sgsdkgo.WorkflowsListAll, error)
Retrieve a list of all workflows in a Stack. Supports Pagination and Filtering using query parameters.
func (*Client) ListAllStackWorkflowsArtifacts ¶
func (c *Client) ListAllStackWorkflowsArtifacts( ctx context.Context, org string, stack string, wf string, wfGrp string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowListAllArtifactsResponse, error)
Retrieve a list of all artifacts for a workflow in a stack. This List All endpoint does not support pagination at the moment.
func (*Client) ReadStackWorkflow ¶
func (c *Client) ReadStackWorkflow( ctx context.Context, org string, stack string, wf string, wfGrp string, opts ...option.RequestOption, ) (*sgsdkgo.WorkflowGetResponse, error)
Retrieve the details of an existing Workflow in a Stack.
func (*Client) StackWorkflowOutputs ¶
func (c *Client) StackWorkflowOutputs( ctx context.Context, org string, stack string, wf string, wfGrp string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowOutputsResponse, error)
Retrieve the outputs for a workflow in a stack.
func (*Client) UpdateStackWorkflow ¶
func (c *Client) UpdateStackWorkflow( ctx context.Context, org string, stack string, wf string, wfGrp string, request *sgsdkgo.PatchedWorkflow, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedWorkflowUpdateResponse, error)
Update an existing workflow in a stack.