Documentation
¶
Index ¶
- type Capabilities
- type CapabilityConfig
- type CreateDeploymentInput
- type CreateDeploymentOutput
- type CreatePlanInput
- type CreatePlanOutput
- type CreateStackInput
- type Data
- func (o Data) MarshalJSON() ([]byte, error)
- func (o *Data) SetAutoSync(v *cross_models.AutoSync) *Data
- func (o *Data) SetCapabilities(v *Capabilities) *Data
- func (o *Data) SetDeploymentApprovalPolicy(v *cross_models.DeploymentApprovalPolicy) *Data
- func (o *Data) SetDeploymentBehavior(v *cross_models.DeploymentBehavior) *Data
- func (o *Data) SetIacConfig(v *cross_models.IacConfig) *Data
- func (o *Data) SetPolicy(v *Policy) *Data
- func (o *Data) SetRunTrigger(v *cross_models.RunTrigger) *Data
- func (o *Data) SetRunnerConfig(v *cross_models.RunnerConfig) *Data
- func (o *Data) SetVcsInfo(v *VcsInfo) *Data
- type Dependency
- type DependencyRef
- type Deployment
- type Plan
- type Policy
- type ReadDeploymentInput
- type ReadDeploymentOutput
- type ReadPlanInput
- type ReadPlanOutput
- type Service
- type ServiceOp
- func (s *ServiceOp) CreateDependency(ctx context.Context, input *Dependency) (*Dependency, error)
- func (s *ServiceOp) CreateDeployment(ctx context.Context, input *CreateDeploymentInput) (*CreateDeploymentOutput, error)
- func (s *ServiceOp) CreatePlan(ctx context.Context, input *CreatePlanInput) (*CreatePlanOutput, error)
- func (s *ServiceOp) CreateStack(ctx context.Context, input *Stack) (*Stack, error)
- func (s *ServiceOp) DeleteDependency(ctx context.Context, dependencyId string) (*commons.EmptyResponse, error)
- func (s *ServiceOp) DeleteStack(ctx context.Context, stackId string) (*commons.EmptyResponse, error)
- func (s *ServiceOp) ListStacks(ctx context.Context, stackId *string, stackName *string, namespaceId *string) ([]*Stack, error)
- func (s *ServiceOp) ReadDependency(ctx context.Context, dependencyId string) (*Dependency, error)
- func (s *ServiceOp) ReadDeployment(ctx context.Context, input *ReadDeploymentInput) (*ReadDeploymentOutput, error)
- func (s *ServiceOp) ReadPlan(ctx context.Context, input *ReadPlanInput) (*ReadPlanOutput, error)
- func (s *ServiceOp) ReadStack(ctx context.Context, stackId string) (*Stack, error)
- func (s *ServiceOp) UpdateDependency(ctx context.Context, dependencyId string, input *Dependency) (*Dependency, error)
- func (s *ServiceOp) UpdateStack(ctx context.Context, stackId string, input *Stack) (*Stack, error)
- type Stack
- type TtlConfig
- type TtlDefinition
- type TtlOverride
- type VcsInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Capabilities ¶ added in v1.15.0
type Capabilities struct {
DeployOnPush *CapabilityConfig `json:"deployOnPush,omitempty"`
PlanOnPr *CapabilityConfig `json:"planOnPr,omitempty"`
DriftDetection *CapabilityConfig `json:"driftDetection,omitempty"`
// contains filtered or unexported fields
}
func (Capabilities) MarshalJSON ¶ added in v1.15.0
func (o Capabilities) MarshalJSON() ([]byte, error)
func (*Capabilities) SetDeployOnPush ¶ added in v1.15.0
func (o *Capabilities) SetDeployOnPush(v *CapabilityConfig) *Capabilities
func (*Capabilities) SetDriftDetection ¶ added in v1.15.0
func (o *Capabilities) SetDriftDetection(v *CapabilityConfig) *Capabilities
func (*Capabilities) SetPlanOnPr ¶ added in v1.15.0
func (o *Capabilities) SetPlanOnPr(v *CapabilityConfig) *Capabilities
type CapabilityConfig ¶ added in v1.15.0
type CapabilityConfig struct {
Status *string `json:"status,omitempty"` // enabled/disabled
// contains filtered or unexported fields
}
func (CapabilityConfig) MarshalJSON ¶ added in v1.15.0
func (o CapabilityConfig) MarshalJSON() ([]byte, error)
func (*CapabilityConfig) SetStatus ¶ added in v1.15.0
func (o *CapabilityConfig) SetStatus(v *string) *CapabilityConfig
type CreateDeploymentInput ¶
type CreateDeploymentInput struct {
StackId *string `json:"stackId,omitempty"`
}
type CreateDeploymentOutput ¶
type CreateDeploymentOutput struct {
Deployment *Deployment `json:"deployment,omitempty"`
}
type CreatePlanInput ¶
type CreatePlanOutput ¶
type CreatePlanOutput struct {
Plan *Plan `json:"plan,omitempty"`
}
type CreateStackInput ¶
type CreateStackInput struct {
Stack *Stack `json:"stack,omitempty"`
}
type Data ¶
type Data struct {
DeploymentBehavior *cross_models.DeploymentBehavior `json:"deploymentBehavior,omitempty"`
DeploymentApprovalPolicy *cross_models.DeploymentApprovalPolicy `json:"deploymentApprovalPolicy,omitempty"`
VcsInfo *VcsInfo `json:"vcsInfo,omitempty"`
RunTrigger *cross_models.RunTrigger `json:"runTrigger,omitempty"`
IacConfig *cross_models.IacConfig `json:"iacConfig,omitempty"`
Policy *Policy `json:"policy,omitempty"`
RunnerConfig *cross_models.RunnerConfig `json:"runnerConfig,omitempty"`
Capabilities *Capabilities `json:"capabilities,omitempty"`
AutoSync *cross_models.AutoSync `json:"autoSync,omitempty"`
// contains filtered or unexported fields
}
func (Data) MarshalJSON ¶
func (*Data) SetAutoSync ¶ added in v1.3.0
func (o *Data) SetAutoSync(v *cross_models.AutoSync) *Data
func (*Data) SetCapabilities ¶ added in v1.15.0
func (o *Data) SetCapabilities(v *Capabilities) *Data
func (*Data) SetDeploymentApprovalPolicy ¶ added in v1.3.0
func (o *Data) SetDeploymentApprovalPolicy(v *cross_models.DeploymentApprovalPolicy) *Data
func (*Data) SetDeploymentBehavior ¶
func (o *Data) SetDeploymentBehavior(v *cross_models.DeploymentBehavior) *Data
func (*Data) SetIacConfig ¶
func (o *Data) SetIacConfig(v *cross_models.IacConfig) *Data
func (*Data) SetRunTrigger ¶
func (o *Data) SetRunTrigger(v *cross_models.RunTrigger) *Data
func (*Data) SetRunnerConfig ¶ added in v1.3.0
func (o *Data) SetRunnerConfig(v *cross_models.RunnerConfig) *Data
func (*Data) SetVcsInfo ¶
type Dependency ¶ added in v1.15.0
type Dependency struct {
ID *string `json:"id,omitempty"`
StackId *string `json:"stackId,omitempty"`
DependsOnStackId *string `json:"dependsOnStackId,omitempty"`
References []*DependencyRef `json:"references,omitempty"`
TriggerOption *string `json:"triggerOption,omitempty"`
// contains filtered or unexported fields
}
func (Dependency) MarshalJSON ¶ added in v1.15.0
func (o Dependency) MarshalJSON() ([]byte, error)
func (*Dependency) SetDependsOnStackId ¶ added in v1.15.0
func (o *Dependency) SetDependsOnStackId(v *string) *Dependency
func (*Dependency) SetReferences ¶ added in v1.15.0
func (o *Dependency) SetReferences(v []*DependencyRef) *Dependency
func (*Dependency) SetStackId ¶ added in v1.15.0
func (o *Dependency) SetStackId(v *string) *Dependency
func (*Dependency) SetTriggerOption ¶ added in v1.15.0
func (o *Dependency) SetTriggerOption(v *string) *Dependency
type DependencyRef ¶ added in v1.15.0
type DependencyRef struct {
OutputOfStackToDependOn *string `json:"outputOfStackToDependOn,omitempty"`
InputForStack *string `json:"inputForStack,omitempty"`
IncludeSensitiveOutput *bool `json:"includeSensitiveOutput,omitempty"`
// contains filtered or unexported fields
}
func (DependencyRef) MarshalJSON ¶ added in v1.15.0
func (o DependencyRef) MarshalJSON() ([]byte, error)
func (*DependencyRef) SetIncludeSensitiveOutput ¶ added in v1.15.0
func (o *DependencyRef) SetIncludeSensitiveOutput(v *bool) *DependencyRef
func (*DependencyRef) SetInputForStack ¶ added in v1.15.0
func (o *DependencyRef) SetInputForStack(v *string) *DependencyRef
func (*DependencyRef) SetOutputOfStackToDependOn ¶ added in v1.15.0
func (o *DependencyRef) SetOutputOfStackToDependOn(v *string) *DependencyRef
type Deployment ¶
type Deployment struct {
ID *string `json:"id,omitempty"`
Status *string `json:"status,omitempty"`
IsActive *bool `json:"isActive,omitempty"`
// Read-only fields.
CreatedAt *time.Time `json:"createdAt,omitempty"`
// contains filtered or unexported fields
}
func (Deployment) MarshalJSON ¶
func (o Deployment) MarshalJSON() ([]byte, error)
func (*Deployment) SetID ¶
func (o *Deployment) SetID(v *string) *Deployment
type Plan ¶
type Plan struct {
ID *string `json:"id,omitempty"`
Status *string `json:"status,omitempty"`
IsActive *bool `json:"isActive,omitempty"`
// Read-only fields.
CreatedAt *time.Time `json:"createdAt,omitempty"`
// contains filtered or unexported fields
}
func (Plan) MarshalJSON ¶
type Policy ¶
type Policy struct {
TtlConfig *TtlConfig `json:"ttlConfig,omitempty"`
// contains filtered or unexported fields
}
func (Policy) MarshalJSON ¶
func (*Policy) SetTtlConfig ¶
type ReadDeploymentInput ¶
type ReadDeploymentInput struct {
DeploymentId *string `json:"deploymentId,omitempty"`
}
type ReadDeploymentOutput ¶
type ReadDeploymentOutput struct {
Deployment *Deployment `json:"deployment,omitempty"`
}
type ReadPlanInput ¶
type ReadPlanInput struct {
PlanId *string `json:"planId,omitempty"`
}
type ReadPlanOutput ¶
type ReadPlanOutput struct {
Plan *Plan `json:"plan,omitempty"`
}
type Service ¶
type Service interface {
CreateStack(context.Context, *Stack) (*Stack, error)
ListStacks(context.Context, *string, *string, *string) ([]*Stack, error)
ReadStack(context.Context, string) (*Stack, error)
UpdateStack(context.Context, string, *Stack) (*Stack, error)
DeleteStack(context.Context, string) (*commons.EmptyResponse, error)
CreateDeployment(context.Context, *CreateDeploymentInput) (*CreateDeploymentOutput, error)
ReadDeployment(context.Context, *ReadDeploymentInput) (*ReadDeploymentOutput, error)
CreatePlan(context.Context, *CreatePlanInput) (*CreatePlanOutput, error)
ReadPlan(context.Context, *ReadPlanInput) (*ReadPlanOutput, error)
CreateDependency(context.Context, *Dependency) (*Dependency, error)
ReadDependency(context.Context, string) (*Dependency, error)
UpdateDependency(context.Context, string, *Dependency) (*Dependency, error)
DeleteDependency(context.Context, string) (*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.
type ServiceOp ¶
func (*ServiceOp) CreateDependency ¶ added in v1.15.0
func (s *ServiceOp) CreateDependency(ctx context.Context, input *Dependency) (*Dependency, error)
func (*ServiceOp) CreateDeployment ¶
func (s *ServiceOp) CreateDeployment(ctx context.Context, input *CreateDeploymentInput) (*CreateDeploymentOutput, error)
func (*ServiceOp) CreatePlan ¶
func (s *ServiceOp) CreatePlan(ctx context.Context, input *CreatePlanInput) (*CreatePlanOutput, error)
func (*ServiceOp) CreateStack ¶
func (*ServiceOp) DeleteDependency ¶ added in v1.15.0
func (*ServiceOp) DeleteStack ¶
func (*ServiceOp) ListStacks ¶
func (*ServiceOp) ReadDependency ¶ added in v1.15.0
func (*ServiceOp) ReadDeployment ¶
func (s *ServiceOp) ReadDeployment(ctx context.Context, input *ReadDeploymentInput) (*ReadDeploymentOutput, error)
func (*ServiceOp) ReadPlan ¶
func (s *ServiceOp) ReadPlan(ctx context.Context, input *ReadPlanInput) (*ReadPlanOutput, error)
func (*ServiceOp) UpdateDependency ¶ added in v1.15.0
func (s *ServiceOp) UpdateDependency(ctx context.Context, dependencyId string, input *Dependency) (*Dependency, error)
type Stack ¶
type Stack struct {
ID *string `json:"id,omitempty"` // read-only
IacType *string `json:"iacType,omitempty"` //commons.IacTypes
NamespaceId *string `json:"namespaceId,omitempty"`
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
Data *Data `json:"data,omitempty"`
// contains filtered or unexported fields
}
func (Stack) MarshalJSON ¶
func (*Stack) SetDescription ¶
func (*Stack) SetIacType ¶
func (*Stack) SetNamespaceId ¶
type TtlConfig ¶
type TtlConfig struct {
Ttl *TtlDefinition `json:"ttl,omitempty"`
TtlOverride *TtlOverride `json:"ttlOverride,omitempty"`
// contains filtered or unexported fields
}
func (TtlConfig) MarshalJSON ¶
func (*TtlConfig) SetTtl ¶
func (o *TtlConfig) SetTtl(v *TtlDefinition) *TtlConfig
func (*TtlConfig) SetTtlOverride ¶ added in v1.3.0
func (o *TtlConfig) SetTtlOverride(v *TtlOverride) *TtlConfig
type TtlDefinition ¶
type TtlDefinition struct {
Type *string `json:"type,omitempty"` //commons.TtlTypes
Value *int `json:"value,omitempty"`
// contains filtered or unexported fields
}
func (TtlDefinition) MarshalJSON ¶
func (o TtlDefinition) MarshalJSON() ([]byte, error)
func (*TtlDefinition) SetType ¶
func (o *TtlDefinition) SetType(v *string) *TtlDefinition
func (*TtlDefinition) SetValue ¶
func (o *TtlDefinition) SetValue(v *int) *TtlDefinition
type TtlOverride ¶ added in v1.3.0
type TtlOverride struct {
Type *string `json:"type,omitempty"` //commons.TtlTypes
Value *int `json:"value,omitempty"`
EffectiveFrom *time.Time `json:"effectiveFrom,omitempty"`
// contains filtered or unexported fields
}
func (TtlOverride) MarshalJSON ¶ added in v1.3.0
func (o TtlOverride) MarshalJSON() ([]byte, error)
func (*TtlOverride) SetType ¶ added in v1.3.0
func (o *TtlOverride) SetType(v *string) *TtlOverride
func (*TtlOverride) SetValue ¶ added in v1.3.0
func (o *TtlOverride) SetValue(v *int) *TtlOverride
type VcsInfo ¶
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 ¶
func (*VcsInfo) SetProviderId ¶
func (*VcsInfo) SetRepoName ¶
Click to show internal directories.
Click to hide internal directories.