blueprint

package
v1.18.0 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Blueprint added in v1.10.0 

type Blueprint struct {
	ID                               *string                `json:"id,omitempty"` // read-only
	Name                             *string                `json:"name,omitempty"`
	Description                      *string                `json:"description,omitempty"`
	BlueprintVcsInfo                 *VcsInfo               `json:"vcsInfo,omitempty"`
	StackConfiguration               *StackConfiguration    `json:"stackConfiguration,omitempty"`
	SubstituteParameters             []*SubstituteParameter `json:"substituteParameters,omitempty"`
	Policy                           *Policy                `json:"policy,omitempty"`
	SkipPlanOnStackInitialization    *bool                  `json:"skipPlanOnStackInitialization,omitempty"`
	AutoApproveApplyOnInitialization *bool                  `json:"autoApproveApplyOnInitialization,omitempty"`
	// contains filtered or unexported fields
}

func (Blueprint) MarshalJSON added in v1.10.0 

func (o Blueprint) MarshalJSON() ([]byte, error)

func (*Blueprint) SetAutoApproveApplyOnInitialization added in v1.13.0 

func (o *Blueprint) SetAutoApproveApplyOnInitialization(v *bool) *Blueprint

func (*Blueprint) SetBlueprintVcsInfo added in v1.13.0 

func (o *Blueprint) SetBlueprintVcsInfo(v *VcsInfo) *Blueprint

func (*Blueprint) SetDescription added in v1.13.0 

func (o *Blueprint) SetDescription(v *string) *Blueprint

func (*Blueprint) SetName added in v1.10.0 

func (o *Blueprint) SetName(v *string) *Blueprint

func (*Blueprint) SetPolicy added in v1.16.0 

func (o *Blueprint) SetPolicy(v *Policy) *Blueprint

region Policy

func (*Blueprint) SetSkipPlanOnStackInitialization added in v1.13.0 

func (o *Blueprint) SetSkipPlanOnStackInitialization(v *bool) *Blueprint

func (*Blueprint) SetStackConfiguration added in v1.13.0 

func (o *Blueprint) SetStackConfiguration(v *StackConfiguration) *Blueprint

func (*Blueprint) SetSubstituteParameters added in v1.13.0 

func (o *Blueprint) SetSubstituteParameters(v []*SubstituteParameter) *Blueprint

type BlueprintNamespaceMapping 

type BlueprintNamespaceMapping struct {
	BlueprintId *string `json:"blueprintId,omitempty"`
	NamespaceId *string `json:"namespaceId,omitempty"`
	// contains filtered or unexported fields
}

func (BlueprintNamespaceMapping) MarshalJSON 

func (o BlueprintNamespaceMapping) MarshalJSON() ([]byte, error)

func (*BlueprintNamespaceMapping) SetBlueprintId 

func (o *BlueprintNamespaceMapping) SetBlueprintId(v *string) *BlueprintNamespaceMapping

func (*BlueprintNamespaceMapping) SetNamespaceId 

func (o *BlueprintNamespaceMapping) SetNamespaceId(v *string) *BlueprintNamespaceMapping

type Policy added in v1.16.0 

type Policy struct {
	TtlConfig *TtlConfig `json:"ttlConfig,omitempty"`
	// contains filtered or unexported fields
}

func (Policy) MarshalJSON added in v1.16.0 

func (o Policy) MarshalJSON() ([]byte, error)

func (*Policy) SetTtlConfig added in v1.16.0 

func (o *Policy) SetTtlConfig(v *TtlConfig) *Policy

type Service 

type Service interface {
	CreateBlueprint(context.Context, *Blueprint) (*Blueprint, error)
	ListBlueprints(context.Context, *string, *string) ([]*Blueprint, error)
	ReadBlueprint(context.Context, string) (*Blueprint, error)
	UpdateBlueprint(context.Context, string, *Blueprint) (*Blueprint, error)
	DeleteBlueprint(context.Context, string) (*commons.EmptyResponse, error)

	ListBlueprintNamespaceMappings(context.Context, string) ([]*BlueprintNamespaceMapping, error)
	CreateBlueprintNamespaceMapping(context.Context, *BlueprintNamespaceMapping) (*BlueprintNamespaceMapping, error)
	DeleteBlueprintNamespaceMapping(context.Context, *BlueprintNamespaceMapping) (*commons.EmptyResponse, error)
}

Service provides the API operation methods for making requests to endpoints of the ControlMonkey API. See this package's package overview docs for details on the service.

func New 

func New(sess *session.Session, cfgs ...*controlmonkey.Config) Service

type ServiceOp 

type ServiceOp struct {
	Client *client.Client
}

func (*ServiceOp) CreateBlueprint added in v1.13.0 

func (s *ServiceOp) CreateBlueprint(ctx context.Context, input *Blueprint) (*Blueprint, error)

func (*ServiceOp) CreateBlueprintNamespaceMapping 

func (s *ServiceOp) CreateBlueprintNamespaceMapping(ctx context.Context, input *BlueprintNamespaceMapping) (*BlueprintNamespaceMapping, error)

func (*ServiceOp) DeleteBlueprint added in v1.13.0 

func (s *ServiceOp) DeleteBlueprint(ctx context.Context, blueprintId string) (*commons.EmptyResponse, error)

func (*ServiceOp) DeleteBlueprintNamespaceMapping 

func (s *ServiceOp) DeleteBlueprintNamespaceMapping(ctx context.Context, input *BlueprintNamespaceMapping) (*commons.EmptyResponse, error)

func (*ServiceOp) ListBlueprintNamespaceMappings 

func (s *ServiceOp) ListBlueprintNamespaceMappings(ctx context.Context, blueprintId string) ([]*BlueprintNamespaceMapping, error)

func (*ServiceOp) ListBlueprints added in v1.10.0 

func (s *ServiceOp) ListBlueprints(ctx context.Context, blueprintId *string, blueprintName *string) ([]*Blueprint, error)

func (*ServiceOp) ReadBlueprint added in v1.13.0 

func (s *ServiceOp) ReadBlueprint(ctx context.Context, blueprintId string) (*Blueprint, error)

func (*ServiceOp) UpdateBlueprint added in v1.13.0 

func (s *ServiceOp) UpdateBlueprint(ctx context.Context, blueprintId string, input *Blueprint) (*Blueprint, error)

type StackConfiguration added in v1.13.0 

type StackConfiguration struct {
	NamePattern              *string                                `json:"name,omitempty"`
	IacType                  *string                                `json:"iacType,omitempty"`
	VcsInfoWithPatterns      *StackVcsInfoWithPatterns              `json:"vcsInfo,omitempty"`
	DeploymentApprovalPolicy *cross_models.DeploymentApprovalPolicy `json:"deploymentApprovalPolicy,omitempty"`
	RunTrigger               *cross_models.RunTrigger               `json:"runTrigger,omitempty"`
	IacConfig                *cross_models.IacConfig                `json:"iacConfig,omitempty"`
	AutoSync                 *cross_models.AutoSync                 `json:"autoSync,omitempty"`
	// contains filtered or unexported fields
}

func (StackConfiguration) MarshalJSON added in v1.13.0 

func (o StackConfiguration) MarshalJSON() ([]byte, error)

func (*StackConfiguration) SetAutoSync added in v1.15.0 

func (o *StackConfiguration) SetAutoSync(v *cross_models.AutoSync) *StackConfiguration

func (*StackConfiguration) SetDeploymentApprovalPolicy added in v1.13.0 

func (o *StackConfiguration) SetDeploymentApprovalPolicy(v *cross_models.DeploymentApprovalPolicy) *StackConfiguration

func (*StackConfiguration) SetIacConfig added in v1.15.0 

func (o *StackConfiguration) SetIacConfig(v *cross_models.IacConfig) *StackConfiguration

func (*StackConfiguration) SetIacType added in v1.13.0 

func (o *StackConfiguration) SetIacType(v *string) *StackConfiguration

func (*StackConfiguration) SetNamePattern added in v1.13.0 

func (o *StackConfiguration) SetNamePattern(v *string) *StackConfiguration

func (*StackConfiguration) SetRunTrigger added in v1.15.0 

func (o *StackConfiguration) SetRunTrigger(v *cross_models.RunTrigger) *StackConfiguration

func (*StackConfiguration) SetVcsInfoWithPatterns added in v1.13.0 

func (o *StackConfiguration) SetVcsInfoWithPatterns(v *StackVcsInfoWithPatterns) *StackConfiguration

type StackVcsInfoWithPatterns added in v1.13.0 

type StackVcsInfoWithPatterns struct {
	ProviderId    *string `json:"providerId,omitempty"`
	RepoName      *string `json:"repoName,omitempty"`
	PathPattern   *string `json:"path,omitempty"`
	BranchPattern *string `json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (StackVcsInfoWithPatterns) MarshalJSON added in v1.13.0 

func (o StackVcsInfoWithPatterns) MarshalJSON() ([]byte, error)

func (*StackVcsInfoWithPatterns) SetBranchPattern added in v1.13.0 

func (o *StackVcsInfoWithPatterns) SetBranchPattern(v *string) *StackVcsInfoWithPatterns

func (*StackVcsInfoWithPatterns) SetPathPattern added in v1.13.0 

func (o *StackVcsInfoWithPatterns) SetPathPattern(v *string) *StackVcsInfoWithPatterns

func (*StackVcsInfoWithPatterns) SetProviderId added in v1.13.0 

func (o *StackVcsInfoWithPatterns) SetProviderId(v *string) *StackVcsInfoWithPatterns

func (*StackVcsInfoWithPatterns) SetRepoName added in v1.13.0 

func (o *StackVcsInfoWithPatterns) SetRepoName(v *string) *StackVcsInfoWithPatterns

type SubstituteParameter added in v1.13.0 

type SubstituteParameter struct {
	Key             *string                   `json:"key,omitempty"`
	Description     *string                   `json:"description,omitempty"`
	ValueConditions []*cross_models.Condition `json:"valueConditions,omitempty"`
	// contains filtered or unexported fields
}

func (SubstituteParameter) MarshalJSON added in v1.13.0 

func (o SubstituteParameter) MarshalJSON() ([]byte, error)

func (*SubstituteParameter) SetDescription added in v1.13.0 

func (o *SubstituteParameter) SetDescription(v *string) *SubstituteParameter

func (*SubstituteParameter) SetKey added in v1.13.0 

func (o *SubstituteParameter) SetKey(v *string) *SubstituteParameter

func (*SubstituteParameter) SetValueConditions added in v1.13.0 

func (o *SubstituteParameter) SetValueConditions(v []*cross_models.Condition) *SubstituteParameter

type TtlConfig added in v1.16.0 

type TtlConfig struct {
	MaxTtl                        *TtlDefinition `json:"maxTtl,omitempty"`
	DefaultTtl                    *TtlDefinition `json:"defaultTtl,omitempty"`
	OpenCleanupPrOnTtlTermination *bool          `json:"openCleanupPrOnTtlTermination,omitempty"`
	// contains filtered or unexported fields
}

func (TtlConfig) MarshalJSON added in v1.16.0 

func (o TtlConfig) MarshalJSON() ([]byte, error)

func (*TtlConfig) SetDefaultTtl added in v1.16.0 

func (o *TtlConfig) SetDefaultTtl(v *TtlDefinition) *TtlConfig

func (*TtlConfig) SetMaxTtl added in v1.16.0 

func (o *TtlConfig) SetMaxTtl(v *TtlDefinition) *TtlConfig

func (*TtlConfig) SetOpenCleanupPrOnTtlTermination added in v1.16.0 

func (o *TtlConfig) SetOpenCleanupPrOnTtlTermination(v *bool) *TtlConfig

type TtlDefinition added in v1.16.0 

type TtlDefinition struct {
	Type  *string `json:"type,omitempty"` //commons.TtlTypes
	Value *int    `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (TtlDefinition) MarshalJSON added in v1.16.0 

func (o TtlDefinition) MarshalJSON() ([]byte, error)

func (*TtlDefinition) SetType added in v1.16.0 

func (o *TtlDefinition) SetType(v *string) *TtlDefinition

func (*TtlDefinition) SetValue added in v1.16.0 

func (o *TtlDefinition) SetValue(v *int) *TtlDefinition

type VcsInfo added in v1.13.0 

type VcsInfo struct {
	ProviderId *string `json:"providerId,omitempty"`
	RepoName   *string `json:"repoName,omitempty"`
	Path       *string `json:"path,omitempty"`
	Branch     *string `json:"branch,omitempty"`
	// contains filtered or unexported fields
}

func (VcsInfo) MarshalJSON added in v1.13.0 

func (o VcsInfo) MarshalJSON() ([]byte, error)

func (*VcsInfo) SetBranch added in v1.13.0 

func (o *VcsInfo) SetBranch(v *string) *VcsInfo

func (*VcsInfo) SetPath added in v1.13.0 

func (o *VcsInfo) SetPath(v *string) *VcsInfo

func (*VcsInfo) SetProviderId added in v1.13.0 

func (o *VcsInfo) SetProviderId(v *string) *VcsInfo

func (*VcsInfo) SetRepoName added in v1.13.0 

func (o *VcsInfo) SetRepoName(v *string) *VcsInfo

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.