variable

type Client struct {
	*otfapi.Client
}

type CreateVariableOptions struct {
	Key         *string
	Value       *string
	Description *string
	Category    *VariableCategory
	Sensitive   *bool
	HCL         *bool
	// contains filtered or unexported fields
}

type CreateVariableSetOptions struct {
	Name        string
	Description string
	Global      bool
	Workspaces  []string // workspace IDs
}

type Options struct {
	WorkspaceAuthorizer internal.Authorizer
	WorkspaceService    workspace.Service

	*sql.DB
	*tfeapi.Responder
	html.Renderer
	logr.Logger
	run.RunService
}

type Service interface {
	// ListEffectiveVariables lists the effective variables for a run, i.e.
	// merging variable sets, workspace variables, and run variables, and
	// removing those that are overridden according to precedence rules.
	ListEffectiveVariables(ctx context.Context, runID string) ([]*Variable, error)

	CreateWorkspaceVariable(ctx context.Context, workspaceID string, opts CreateVariableOptions) (*Variable, error)
	UpdateWorkspaceVariable(ctx context.Context, variableID string, opts UpdateVariableOptions) (*WorkspaceVariable, error)
	ListWorkspaceVariables(ctx context.Context, workspaceID string) ([]*Variable, error)
	GetWorkspaceVariable(ctx context.Context, variableID string) (*WorkspaceVariable, error)
	DeleteWorkspaceVariable(ctx context.Context, variableID string) (*WorkspaceVariable, error)
	// contains filtered or unexported methods
}

type UpdateVariableOptions struct {
	Key         *string
	Value       *string
	Description *string
	Category    *VariableCategory
	Sensitive   *bool
	HCL         *bool
	// contains filtered or unexported fields
}

type UpdateVariableSetOptions struct {
	Name        *string
	Description *string
	Global      *bool
	Workspaces  []string // workspace IDs
}

type Variable struct {
	ID          string           `jsonapi:"primary,variables"`
	Key         string           `jsonapi:"attribute" json:"key"`
	Value       string           `jsonapi:"attribute" json:"value"`
	Description string           `jsonapi:"attribute" json:"description"`
	Category    VariableCategory `jsonapi:"attribute" json:"category"`
	Sensitive   bool             `jsonapi:"attribute" json:"sensitive"`
	HCL         bool             `jsonapi:"attribute" json:"hcl"`

	// OTF doesn't use this internally but the go-tfe integration tests
	// expect it to be a random value that changes on every update.
	VersionID string
}

type VariableCategory string

type VariableService = Service

type VariableSet struct {
	ID           string
	Name         string
	Description  string
	Global       bool
	Workspaces   []string // workspace IDs
	Organization string   // org name
	Variables    []*Variable
}

type WorkspaceVariable struct {
	*Variable
	WorkspaceID string
}