Documentation
¶
Overview ¶
Stacks enable you to organize and execute multiple related workflows in a defined sequence. These workflows are designed to work together, where the output of one workflow is automatically passed as the input for the next.
For more details, please visit our [Documentation](https://docs.stackguardian.io/docs/deploy/stack/overview/).
Index ¶
- type Client
- func (c *Client) CreateStack(ctx context.Context, org string, wfGrp string, request *sgsdkgo.Stack, ...) (*sgsdkgo.GeneratedStackCreateResponse, error)
- func (c *Client) DeleteStack(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.StackDeleteResponse, error)
- func (c *Client) ListAllStacks(ctx context.Context, org string, wfGrp string, ...) (*sgsdkgo.GeneratedStackListAllResponse, error)
- func (c *Client) ReadStack(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.GeneratedStackGetResponse, error)
- func (c *Client) ReadStackOutputs(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.GeneratedStackOutputsResponse, error)
- func (c *Client) UpdateStack(ctx context.Context, org string, stack string, wfGrp string, ...) (*sgsdkgo.GeneratedStackUpdateResponse, 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) CreateStack ¶
func (c *Client) CreateStack( ctx context.Context, org string, wfGrp string, request *sgsdkgo.Stack, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackCreateResponse, error)
Creates a new Stack.
func (*Client) DeleteStack ¶
func (c *Client) DeleteStack( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.DeleteStackRequest, opts ...option.RequestOption, ) (*sgsdkgo.StackDeleteResponse, error)
Deletes an existing stack.
func (*Client) ListAllStacks ¶
func (c *Client) ListAllStacks( ctx context.Context, org string, wfGrp string, request *sgsdkgo.ListAllStacksRequest, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackListAllResponse, error)
Lists all the Stacks inside a Workflow Group. Supports Pagination and Filtering using query parameters.
func (*Client) ReadStack ¶
func (c *Client) ReadStack( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.ReadStackQueryParams, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackGetResponse, error)
Retrieves details of an existing stack.
func (*Client) ReadStackOutputs ¶
func (c *Client) ReadStackOutputs( ctx context.Context, org string, stack string, wfGrp string, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackOutputsResponse, error)
Read outputs of an existing Stack.
func (*Client) UpdateStack ¶
func (c *Client) UpdateStack( ctx context.Context, org string, stack string, wfGrp string, request *sgsdkgo.PatchedStack, opts ...option.RequestOption, ) (*sgsdkgo.GeneratedStackUpdateResponse, error)
Updates an existing stack.
Source Files
Click to show internal directories.
Click to hide internal directories.