Documentation
¶
Overview ¶
A Stack run refers to a single execution instance of a defined stack, where the actions specified in the stack run configuration are carried out.
For more details, visit our [Documentation](https://docs.stackguardian.io/docs/deploy/stack/overview/).
Index ¶
- type Client
- func (c *Client) CreateStackRun(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.GeneratedStackRunsResponse, error)
- func (c *Client) ListAllStackRuns(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.GeneratedStackRunsListAllResponse, error)
- func (c *Client) ReadStackRun(ctx context.Context, org string, stack string, stackRun string, wfGrp string, ...) (*sgsdkgo.GeneratedStackRunsGetResponse, 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) CreateStackRun ¶
func (c *Client) CreateStackRun( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.StackAction, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackRunsResponse, error)
Initiates a new run of an existing stack.
func (*Client) ListAllStackRuns ¶
func (c *Client) ListAllStackRuns( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.ListAllStackRunsRequest, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackRunsListAllResponse, error)
Retrieves a list of all stack runs for a specific stack. Supports Pagination and Filtering using query parameters.
func (*Client) ReadStackRun ¶
func (c *Client) ReadStackRun( ctx context.Context, org string, stack string, stackRun string, wfGrp string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackRunsGetResponse, error)
Retrieves details of all workflow runs within a specific stack run.
Source Files
Click to show internal directories.
Click to hide internal directories.