workspace

type CLI struct {
	// contains filtered or unexported fields
}

type Client struct {
	*otfapi.Client
}

type ConnectOptions struct {
	RepoPath      *string
	VCSProviderID *string

	Branch        *string
	TagsRegex     *string
	AllowCLIApply *bool
}

type Connection struct {
	// Pushes to this VCS branch trigger runs. Empty string means the default
	// branch is used. Ignored if TagsRegex is non-empty.
	Branch string
	// Pushed tags matching this regular expression trigger runs. Mutually
	// exclusive with TriggerPatterns.
	TagsRegex string

	VCSProviderID string
	Repo          string

	// By default, once a workspace is connected to a repo it is not
	// possible to run a terraform apply via the CLI. Setting this to true
	// overrides this behaviour.
	AllowCLIApply bool
}

type CreateOptions struct {
	AgentPoolID                *string
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Description                *string
	ExecutionMode              *ExecutionMode
	GlobalRemoteState          *bool
	MigrationEnvironment       *string
	Name                       *string
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	SourceName                 *string
	SourceURL                  *string
	StructuredRunOutputEnabled *bool
	Tags                       []TagSpec
	TerraformVersion           *string
	TriggerPrefixes            []string
	TriggerPatterns            []string
	WorkingDirectory           *string
	Organization               *string

	// Always trigger runs. A value of true is mutually exclusive with
	// setting TriggerPatterns or ConnectOptions.TagsRegex.
	AlwaysTrigger *bool

	*ConnectOptions
}

type ExecutionMode string

type FakeService struct {
	Workspaces []*Workspace
	Policy     internal.WorkspacePolicy
}

type LatestRun struct {
	ID     string
	Status runStatus
}

type ListOptions struct {
	Search       string
	Tags         []string
	Organization *string `schema:"organization_name"`

	resource.PageOptions
}

type ListTagsOptions struct {
	resource.PageOptions
}

type ListWorkspaceTagsOptions struct {
	resource.PageOptions
}

type Lock struct {
	LockKind // kind of entity holding lock
	// contains filtered or unexported fields
}

type LockButton struct {
	State    string // locked or unlocked
	Text     string // button text
	Tooltip  string // button tooltip
	Disabled bool   // button greyed out or not
	Message  string // message accompanying button
	Action   string // form URL
}

type LockKind int

type Options struct {
	*sql.Pool
	*sql.Listener
	*tfeapi.Responder
	html.Renderer

	Logger *slog.Logger

	OrganizationService *organization.Service
	VCSProviderService  *vcsprovider.Service
	TeamService         *team.Service
	ConnectionService   *connections.Service
}

type Service struct {
	internal.Authorizer // workspace authorizer
	// contains filtered or unexported fields
}

type Tag struct {
	ID            string // ID of the form 'tag-*'. Globally unique.
	Name          string // Meaningful symbol. Unique to an organization.
	InstanceCount int    // Number of workspaces that have this tag
	Organization  string // Organization this tag belongs to.
}

type TagSpec struct {
	ID   string
	Name string
}

type TagSpecs []TagSpec

type UpdateOptions struct {
	AgentPoolID                *string `json:"agent-pool-id,omitempty"`
	AllowDestroyPlan           *bool
	AutoApply                  *bool
	Name                       *string
	Description                *string
	ExecutionMode              *ExecutionMode `json:"execution-mode,omitempty"`
	GlobalRemoteState          *bool
	Operations                 *bool
	QueueAllRuns               *bool
	SpeculativeEnabled         *bool
	StructuredRunOutputEnabled *bool
	TerraformVersion           *string
	TriggerPrefixes            []string
	TriggerPatterns            []string
	WorkingDirectory           *string

	// Always trigger runs. A value of true is mutually exclusive with
	// setting TriggerPatterns or ConnectOptions.TagsRegex.
	AlwaysTrigger *bool

	// Disconnect workspace from repo. It is invalid to specify true for an
	// already disconnected workspace.
	Disconnect bool

	// Specifying ConnectOptions either connects a currently
	// disconnected workspace, or modifies a connection if already
	// connected.
	*ConnectOptions
}

type VCSTriggerStrategy string

type Workspace struct {
	ID                         string        `jsonapi:"primary,workspaces"`
	CreatedAt                  time.Time     `jsonapi:"attribute" json:"created_at"`
	UpdatedAt                  time.Time     `jsonapi:"attribute" json:"updated_at"`
	AgentPoolID                *string       `jsonapi:"attribute" json:"agent-pool-id"`
	AllowDestroyPlan           bool          `jsonapi:"attribute" json:"allow_destroy_plan"`
	AutoApply                  bool          `jsonapi:"attribute" json:"auto_apply"`
	CanQueueDestroyPlan        bool          `jsonapi:"attribute" json:"can_queue_destroy_plan"`
	Description                string        `jsonapi:"attribute" json:"description"`
	Environment                string        `jsonapi:"attribute" json:"environment"`
	ExecutionMode              ExecutionMode `jsonapi:"attribute" json:"execution_mode"`
	GlobalRemoteState          bool          `jsonapi:"attribute" json:"global_remote_state"`
	MigrationEnvironment       string        `jsonapi:"attribute" json:"migration_environment"`
	Name                       string        `jsonapi:"attribute" json:"name"`
	QueueAllRuns               bool          `jsonapi:"attribute" json:"queue_all_runs"`
	SpeculativeEnabled         bool          `jsonapi:"attribute" json:"speculative_enabled"`
	StructuredRunOutputEnabled bool          `jsonapi:"attribute" json:"structured_run_output_enabled"`
	SourceName                 string        `jsonapi:"attribute" json:"source_name"`
	SourceURL                  string        `jsonapi:"attribute" json:"source_url"`
	TerraformVersion           string        `jsonapi:"attribute" json:"terraform_version"`
	WorkingDirectory           string        `jsonapi:"attribute" json:"working_directory"`
	Organization               string        `jsonapi:"attribute" json:"organization"`
	LatestRun                  *LatestRun    `jsonapi:"attribute" json:"latest_run"`
	Tags                       []string      `jsonapi:"attribute" json:"tags"`
	Lock                       *Lock         `jsonapi:"attribute" json:"lock"`

	// VCS Connection; nil means the workspace is not connected.
	Connection *Connection

	// TriggerPatterns is mutually exclusive with Connection.TagsRegex.
	//
	// Note: TriggerPatterns ought to belong in Connection but it is included at
	// the root of Workspace because the go-tfe integration tests set
	// this field without setting the connection!
	TriggerPatterns []string

	// TriggerPrefixes exists only to pass the go-tfe integration tests and
	// is not used when determining whether to trigger runs. Use
	// TriggerPatterns instead.
	TriggerPrefixes []string
}

type WorkspacePage struct {
	organization.OrganizationPage

	Workspace *Workspace
}