workflows

package
v1.1.0-beta-2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 3, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

StackGuardian Workflows are automated sequences designed to deploy, manage, and maintain cloud infrastructure using Infrastructure as Code (IaC) templates.

For more details, visit our [Documentation](https://docs.stackguardian.io/docs/deploy/workflows/overview/).

Index

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) CreateWorkflow

func (c *Client) CreateWorkflow(
	ctx context.Context,
	org string,
	wfGrp string,
	request *sgsdkgo.Workflow,
	opts ...option.RequestOption,
) (*sgsdkgo.GeneratedWorkflowCreateResponse, error)

Create a new workflow.

func (*Client) DeleteWorkflow

func (c *Client) DeleteWorkflow(
	ctx context.Context,
	org string,
	wf string,
	wfGrp string,
	opts ...option.RequestOption,
) (*sgsdkgo.GeneratedWorkflowDeleteResponse, error)

Delete an existing workflow.

func (*Client) ListAllWorkflowArtifacts

func (c *Client) ListAllWorkflowArtifacts(
	ctx context.Context,
	org string,
	wf string,
	wfGrp string,
	opts ...option.RequestOption,
) (*sgsdkgo.GeneratedWorkflowListAllArtifactsResponse, error)

Retrieve a list of all artifacts for a workflow.

func (*Client) ListAllWorkflows

func (c *Client) ListAllWorkflows(
	ctx context.Context,
	org string,
	wfGrp string,
	request *sgsdkgo.ListAllWorkflowsRequest,
	opts ...option.RequestOption,
) (*sgsdkgo.WorkflowsListAll, error)

Retrieve a list of all workflows in a workflow group.

func (*Client) Outputs

Retrieve the outputs for a workflow.

func (*Client) ReadWorkflow

func (c *Client) ReadWorkflow(
	ctx context.Context,
	org string,
	wf string,
	wfGrp string,
	opts ...option.RequestOption,
) (*sgsdkgo.WorkflowGetResponse, error)

Retrieve the details of an existing Workflow.

func (*Client) UpdateWorkflow

func (c *Client) UpdateWorkflow(
	ctx context.Context,
	org string,
	wf string,
	wfGrp string,
	request *sgsdkgo.PatchedWorkflow,
	opts ...option.RequestOption,
) (*sgsdkgo.GeneratedWorkflowUpdateResponse, error)

Update an existing workflow's configuration

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL