variable

package
v1.15.0 Latest Latest
Warning

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

Go to latest
Published: Sep 11, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateVariableOutput

type CreateVariableOutput struct {
	Variable *Variable `json:"variable,omitempty"`
}

type DeleteVariableInput

type DeleteVariableInput struct {
	VariableId *string `json:"variableId"`
}

type DeleteVariableOutput

type DeleteVariableOutput struct{}

type ListVariablesInput

type ListVariablesInput struct {
	StackId     *string `json:"stackId,omitempty"`
	NamespaceId *string `json:"namespaceId,omitempty"`
	TemplateId  *string `json:"templateId,omitempty"`
	StackRunId  *string `json:"stackRunId,omitempty"`
	OrgOnly     *bool   `json:"orgOnly,omitempty"`
}

type ListVariablesOutput

type ListVariablesOutput struct {
	Variables []*Variable `json:"variables,omitempty"`
}

type ReadVariableInput

type ReadVariableInput struct {
	VariableId *string `json:"variableId,omitempty"`
}

type ReadVariableOutput

type ReadVariableOutput struct {
	Variable *Variable `json:"variable,omitempty"`
}

type Service

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

func (s *ServiceOp) CreateVariable(ctx context.Context, input *Variable) (*CreateVariableOutput, error)

func (*ServiceOp) DeleteVariable

func (s *ServiceOp) DeleteVariable(ctx context.Context, input *DeleteVariableInput) (*commons.EmptyResponse, error)

func (*ServiceOp) ListVariables

func (s *ServiceOp) ListVariables(ctx context.Context, input *ListVariablesInput) (*ListVariablesOutput, error)

func (*ServiceOp) ReadVariable

func (s *ServiceOp) ReadVariable(ctx context.Context, input *ReadVariableInput) (*ReadVariableOutput, error)

func (*ServiceOp) UpdateVariable

func (s *ServiceOp) UpdateVariable(ctx context.Context, variableId *string, input *Variable) (*UpdateVariableOutput, error)

type UpdateVariableOutput

type UpdateVariableOutput struct {
	Variable *Variable `json:"variable,omitempty"`
}

type Variable

type Variable struct {
	ID                 *string                   `json:"id,omitempty"`    // read-only
	Scope              *string                   `json:"scope,omitempty"` //commons.VariableScopeTypes
	ScopeId            *string                   `json:"scopeId,omitempty"`
	Key                *string                   `json:"key,omitempty"`
	Value              *string                   `json:"value,omitempty"`
	DisplayName        *string                   `json:"displayName,omitempty"`
	Type               *string                   `json:"type,omitempty"` //commons.VariableTypes
	IsSensitive        *bool                     `json:"isSensitive,omitempty"`
	IsOverridable      *bool                     `json:"isOverridable,omitempty"`
	IsRequired         *bool                     `json:"isRequired,omitempty"`
	Description        *string                   `json:"description,omitempty"`
	ValueConditions    []*cross_models.Condition `json:"valueConditions,omitempty"`
	BlueprintManagedBy *string                   `json:"blueprintManagedBy,omitempty"` //commons.BlueprintVariableManagedByTypes
	// contains filtered or unexported fields
}

func (Variable) MarshalJSON

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

func (*Variable) SetBlueprintManagedBy added in v1.15.0

func (o *Variable) SetBlueprintManagedBy(v *string) *Variable

func (*Variable) SetDescription

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

func (*Variable) SetDisplayName added in v1.13.0

func (o *Variable) SetDisplayName(v *string) *Variable

func (*Variable) SetIsOverridable

func (o *Variable) SetIsOverridable(v *bool) *Variable

func (*Variable) SetIsRequired

func (o *Variable) SetIsRequired(v *bool) *Variable

func (*Variable) SetIsSensitive

func (o *Variable) SetIsSensitive(v *bool) *Variable

func (*Variable) SetKey

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

func (*Variable) SetScope

func (o *Variable) SetScope(v *string) *Variable

func (*Variable) SetScopeId

func (o *Variable) SetScopeId(v *string) *Variable

func (*Variable) SetType

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

func (*Variable) SetValue

func (o *Variable) SetValue(v *string) *Variable

func (*Variable) SetValueConditions added in v1.3.0

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

Jump to

Keyboard shortcuts

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