Help us shape the future of Go! Take the 2026 Go Developer Survey

workflowtemplates

package
v1.8.0 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const TemplateType = "IAC"

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

func (c *Client) CreateWorkflowTemplate(
	ctx context.Context,
	org string,
	createFirstRevision bool,
	request *CreateWorkflowTemplateRequest,
	opts ...option.RequestOption,
) (*CreateWorkflowTemplateResponseModel, error)

func (*Client) DeleteWorkflowTemplate 

func (c *Client) DeleteWorkflowTemplate(
	ctx context.Context,
	org string,
	templateId string,
	opts ...option.RequestOption,
) error

func (*Client) ReadWorkflowTemplate 

func (c *Client) ReadWorkflowTemplate(
	ctx context.Context,
	org string,
	templateId string,
	opts ...option.RequestOption,
) (*ReadWorkflowTemplateResponseModel, error)

func (*Client) UpdateWorkflowTemplate 

func (c *Client) UpdateWorkflowTemplate(
	ctx context.Context,
	org string,
	templateId string,
	request *UpdateWorkflowTemplateRequest,
	opts ...option.RequestOption,
) (*UpdateWorkflowTemplateResponseModel, error)

type CreateWorkflowTemplateRequest 

type CreateWorkflowTemplateRequest struct {
	Id               *string                               `json:"Id,omitempty" url:"Id,omitempty"`
	TemplateName     string                                `json:"TemplateName,omitempty" url:"TemplateName,omitempty"`
	TemplateType     sgsdkgo.TemplateTypeEnum              `json:"TemplateType,omitempty" url:"TemplateType,omitempty"`
	OwnerOrg         string                                `json:"OwnerOrg,omitempty" url:"OwnerOrg,omitempty"`
	SourceConfigKind *WorkflowTemplateSourceConfigKindEnum `json:"SourceConfigKind,omitempty" url:"SourceConfigKind,omitempty"`
	IsActive         *sgsdkgo.IsPublicEnum                 `json:"IsActive,omitempty" url:"IsActive,omitempty"`
	IsPublic         *sgsdkgo.IsPublicEnum                 `json:"IsPublic,omitempty" url:"IsPublic,omitempty"`
	RuntimeSource    *RuntimeSource                        `json:"RuntimeSource,omitempty" url:"RuntimeSource,omitempty"`
	SharedOrgsList   []string                              `json:"SharedOrgsList,omitzero" url:"SharedOrgsList,omitempty"`
	Tags             []string                              `json:"Tags,omitzero" url:"Tags,omitempty"`
	VCSTriggers      *VCSTriggers                          `json:"VCSTriggers,omitempty" url:"VCSTriggers,omitempty"`
	ContextTags      map[string]string                     `json:"ContextTags,omitempty" url:"ContextTags,omitempty"`
	ShortDescription *string                               `json:"ShortDescription,omitempty" url:"ShortDescription,omitempty"`
}

CreateWorkflowTemplateRequest is the body of POST /api/v1/templates/. SharedOrgsList and Tags use `omitzero` rather than `omitempty`: a nil slice leaves the field out and core applies its default, while an explicit empty slice is sent as []. omitzero needs Go 1.24+.

type CreateWorkflowTemplateResponseData 

type CreateWorkflowTemplateResponseData struct {
	Parent CreateWorkflowTemplateRequest `json:"parent,omitempty" url:"parent,omitempty"`
}

type CreateWorkflowTemplateResponseModel 

type CreateWorkflowTemplateResponseModel struct {
	Msg  string                             `json:"msg,omitempty" url:"msg,omitempty"`
	Data CreateWorkflowTemplateResponseData `json:"data,omitempty" url:"data,omitempty"`
}

type ReadWorkflowTemplateResponse 

type ReadWorkflowTemplateResponse struct {
	Id               *string                               `json:"Id,omitempty" url:"Id,omitempty"`
	TemplateName     *string                               `json:"TemplateName,omitempty" url:"TemplateName,omitempty"`
	TemplateType     *sgsdkgo.TemplateTypeEnum             `json:"TemplateType,omitempty" url:"TemplateType,omitempty"`
	OwnerOrg         *string                               `json:"OwnerOrg,omitempty" url:"OwnerOrg,omitempty"`
	ShortDescription *string                               `json:"ShortDescription,omitempty" url:"ShortDescription,omitempty"`
	SourceConfigKind *WorkflowTemplateSourceConfigKindEnum `json:"SourceConfigKind,omitempty" url:"SourceConfigKind,omitempty"`
	IsActive         *sgsdkgo.IsPublicEnum                 `json:"IsActive,omitempty" url:"IsActive,omitempty"`
	IsPublic         *sgsdkgo.IsPublicEnum                 `json:"IsPublic,omitempty" url:"IsPublic,omitempty"`
	RuntimeSource    *RuntimeSource                        `json:"RuntimeSource,omitempty" url:"RuntimeSource,omitempty"`
	SharedOrgsList   []string                              `json:"SharedOrgsList,omitempty" url:"SharedOrgsList,omitempty"`
	Tags             []string                              `json:"Tags,omitempty" url:"Tags,omitempty"`
	VCSTriggers      *VCSTriggers                          `json:"VCSTriggers,omitempty" url:"VCSTriggers,omitempty"`
	ContextTags      map[string]string                     `json:"ContextTags,omitempty" url:"ContextTags,omitempty"`
}

type ReadWorkflowTemplateResponseModel 

type ReadWorkflowTemplateResponseModel struct {
	Msg ReadWorkflowTemplateResponse `json:"msg,omitempty" url:"msg,omitempty"`
}

type RuntimeSource 

type RuntimeSource struct {
	SourceConfigDestKind *SourceConfigDestKindEnum `json:"sourceConfigDestKind,omitempty" url:"sourceConfigDestKind,omitempty"`
	Config               *RuntimeSourceConfig      `json:"config,omitempty" url:"config,omitempty"`
}

type RuntimeSourceConfig 

type RuntimeSourceConfig struct {
	Auth                    *string `json:"auth,omitempty" url:"auth"`
	GitCoreAutoCRLF         *bool   `json:"gitCoreAutoCRLF,omitempty" url:"gitCoreAutoCRLF,omitempty"`
	GitSparseCheckoutConfig *string `json:"gitSparseCheckoutConfig,omitempty" url:"gitSparseCheckoutConfig,omitempty"`
	IncludeSubModule        *bool   `json:"includeSubModule,omitempty" url:"includeSubModule,omitempty"`
	IsPrivate               *bool   `json:"isPrivate,omitempty" url:"isPrivate,omitempty"`
	Ref                     *string `json:"ref,omitempty" url:"ref,omitempty"`
	Repo                    string  `json:"repo,omitempty" url:"repo,omitempty"`
	WorkingDir              *string `json:"workingDir,omitempty" url:"workingDir,omitempty"`
}

type RuntimeSourceConfigUpdate 

type RuntimeSourceConfigUpdate struct {
	Auth                    *string `json:"auth,omitempty" url:"auth,omitempty"`
	GitCoreAutoCRLF         *bool   `json:"gitCoreAutoCRLF,omitempty" url:"gitCoreAutoCRLF,omitempty"`
	GitSparseCheckoutConfig *string `json:"gitSparseCheckoutConfig,omitempty" url:"gitSparseCheckoutConfig,omitempty"`
	IncludeSubModule        *bool   `json:"includeSubModule,omitempty" url:"includeSubModule,omitempty"`
	IsPrivate               *bool   `json:"isPrivate,omitempty" url:"isPrivate,omitempty"`
	Ref                     *string `json:"ref,omitempty" url:"ref,omitempty"`
	WorkingDir              *string `json:"workingDir,omitempty" url:"workingDir,omitempty"`
}

type RuntimeSourceUpdate 

type RuntimeSourceUpdate struct {
	SourceConfigDestKind *SourceConfigDestKindEnum  `json:"sourceConfigDestKind,omitempty" url:"sourceConfigDestKind,omitempty"`
	Config               *RuntimeSourceConfigUpdate `json:"config,omitempty" url:"config,omitempty"`
}

type SourceConfigDestKindEnum 

type SourceConfigDestKindEnum string
const (
	SourceConfigDestKindEnumGithubCom       SourceConfigDestKindEnum = "GITHUB_COM"
	SourceConfigDestKindEnumGithubAppCustom SourceConfigDestKindEnum = "GITHUB_APP_CUSTOM"
	SourceConfigDestKindEnumGitOther        SourceConfigDestKindEnum = "GIT_OTHER"
	SourceConfigDestKindEnumBitbucketOrg    SourceConfigDestKindEnum = "BITBUCKET_ORG"
	SourceConfigDestKindEnumGitlabCom       SourceConfigDestKindEnum = "GITLAB_COM"
	SourceConfigDestKindEnumAzureDevops     SourceConfigDestKindEnum = "AZURE_DEVOPS"
	SourceConfigDestKindEnumAzureDevopsSp   SourceConfigDestKindEnum = "AZURE_DEVOPS_SP"
)

func (SourceConfigDestKindEnum) Ptr 

func (t SourceConfigDestKindEnum) Ptr() *SourceConfigDestKindEnum

type UpdateWorkflowTemplateRequest 

type UpdateWorkflowTemplateRequest struct {
	TemplateName     *core.Optional[string]                               `json:"TemplateName,omitempty" url:"TemplateName,omitempty"`
	OwnerOrg         *core.Optional[string]                               `json:"OwnerOrg,omitempty" url:"OwnerOrg,omitempty"`
	IsActive         *core.Optional[sgsdkgo.IsPublicEnum]                 `json:"IsActive,omitempty" url:"IsActive,omitempty"`
	IsPublic         *core.Optional[sgsdkgo.IsPublicEnum]                 `json:"IsPublic,omitempty" url:"IsPublic,omitempty"`
	ShortDescription *core.Optional[string]                               `json:"ShortDescription,omitempty" url:"ShortDescription,omitempty"`
	SourceConfigKind *core.Optional[WorkflowTemplateSourceConfigKindEnum] `json:"SourceConfigKind,omitempty" url:"SourceConfigKind,omitempty"`
	RuntimeSource    *core.Optional[RuntimeSourceUpdate]                  `json:"RuntimeSource,omitempty" url:"RuntimeSource,omitempty"`
	SharedOrgsList   *core.Optional[[]string]                             `json:"SharedOrgsList,omitempty" url:"SharedOrgsList,omitempty"`
	Tags             *core.Optional[[]string]                             `json:"Tags,omitempty" url:"Tags,omitempty"`
	VCSTriggers      *core.Optional[VCSTriggers]                          `json:"VCSTriggers,omitempty" url:"VCSTriggers,omitempty"`
	ContextTags      *core.Optional[map[string]string]                    `json:"ContextTags,omitempty" url:"ContextTags,omitempty"`
}

type UpdateWorkflowTemplateResponse 

type UpdateWorkflowTemplateResponse struct {
	Id               *core.Optional[string]                               `json:"Id,omitempty" url:"Id,omitempty"`
	TemplateName     *core.Optional[string]                               `json:"TemplateName,omitempty" url:"TemplateName,omitempty"`
	TemplateType     *core.Optional[sgsdkgo.TemplateTypeEnum]             `json:"TemplateType,omitempty" url:"TemplateType,omitempty"`
	OwnerOrg         *core.Optional[string]                               `json:"OwnerOrg,omitempty" url:"OwnerOrg,omitempty"`
	SourceConfigKind *core.Optional[WorkflowTemplateSourceConfigKindEnum] `json:"SourceConfigKind,omitempty" url:"SourceConfigKind,omitempty"`
	IsActive         *core.Optional[sgsdkgo.IsPublicEnum]                 `json:"IsActive,omitempty" url:"IsActive,omitempty"`
	IsPublic         *core.Optional[sgsdkgo.IsPublicEnum]                 `json:"IsPublic,omitempty" url:"IsPublic,omitempty"`
	RuntimeSource    *core.Optional[RuntimeSource]                        `json:"RuntimeSource,omitempty" url:"RuntimeSource,omitempty"`
	SharedOrgsList   *core.Optional[[]string]                             `json:"SharedOrgsList,omitempty" url:"SharedOrgsList,omitempty"`
	Tags             *core.Optional[[]string]                             `json:"Tags,omitempty" url:"Tags,omitempty"`
	VCSTriggers      *core.Optional[VCSTriggers]                          `json:"VCSTriggers,omitempty" url:"VCSTriggers,omitempty"`
	ContextTags      *core.Optional[map[string]string]                    `json:"ContextTags,omitempty" url:"ContextTags,omitempty"`
	ShortDescription *core.Optional[string]                               `json:"ShortDescription,omitempty" url:"ShortDescription,omitempty"`
}

type UpdateWorkflowTemplateResponseModel 

type UpdateWorkflowTemplateResponseModel struct {
	Msg  string                         `json:"msg,omitempty" url:"msg,omitempty"`
	Data UpdateWorkflowTemplateResponse `json:"data,omitempty" url:"data,omitempty"`
}

type VCSTriggers 

type VCSTriggers struct {
	CreateTag *VCSTriggersCreateTag `json:"create_tag,omitempty" url:"create_tag,omitempty"`
	Type      *VCSTriggersTypeEnum  `json:"type,omitempty" url:"type,omitempty"`
}

type VCSTriggersCreateTag 

type VCSTriggersCreateTag struct {
	CreateRevision *VCSTriggersCreateTagCreateRevision `json:"createRevision,omitempty" url:"createRevision,omitempty"`
}

type VCSTriggersCreateTagCreateRevision 

type VCSTriggersCreateTagCreateRevision struct {
	Enabled *bool `json:"enabled,omitempty" url:"enabled,omitempty"`
}

type VCSTriggersTypeEnum 

type VCSTriggersTypeEnum string
const (
	VCSTriggersTypeEnumGithubCom       VCSTriggersTypeEnum = "GITHUB_COM"
	VCSTriggersTypeEnumGithubAppCustom VCSTriggersTypeEnum = "GITHUB_APP_CUSTOM"
	VCSTriggersTypeEnumGitlabOauthSsh  VCSTriggersTypeEnum = "GITLAB_OAUTH_SSH"
	VCSTriggersTypeEnumGitlabCom       VCSTriggersTypeEnum = "GITLAB_COM"
)

func (VCSTriggersTypeEnum) Ptr 

func (t VCSTriggersTypeEnum) Ptr() *VCSTriggersTypeEnum

type WorkflowTemplateSourceConfigKindEnum 

type WorkflowTemplateSourceConfigKindEnum string
const (
	WorkflowTemplateSourceConfigKindTerraform       WorkflowTemplateSourceConfigKindEnum = "TERRAFORM"
	WorkflowTemplateSourceConfigKindOpentofu        WorkflowTemplateSourceConfigKindEnum = "OPENTOFU"
	WorkflowTemplateSourceConfigKindAnsiblePlaybook WorkflowTemplateSourceConfigKindEnum = "ANSIBLE_PLAYBOOK"
	WorkflowTemplateSourceConfigKindHelm            WorkflowTemplateSourceConfigKindEnum = "HELM"
	WorkflowTemplateSourceConfigKindKubectl         WorkflowTemplateSourceConfigKindEnum = "KUBECTL"
	WorkflowTemplateSourceConfigKindCloudformation  WorkflowTemplateSourceConfigKindEnum = "CLOUDFORMATION"
	WorkflowTemplateSourceConfigKindCustom          WorkflowTemplateSourceConfigKindEnum = "CUSTOM"
)

func NewWorkflowTemplateSourceConfigKindEnumFromString 

func NewWorkflowTemplateSourceConfigKindEnumFromString(s string) (WorkflowTemplateSourceConfigKindEnum, error)

func (WorkflowTemplateSourceConfigKindEnum) Ptr 

func (t WorkflowTemplateSourceConfigKindEnum) Ptr() *WorkflowTemplateSourceConfigKindEnum

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.