state

type CLI struct {
	Service
	workspace.WorkspaceService
}

type Client struct {
	*otfapi.Client

	// Client does not implement all of service yet
	Service
}

type CreateStateVersionOptions struct {
	State       []byte  // Terraform state file. Optional.
	WorkspaceID *string // ID of state version's workspace. Required.
	Serial      *int64  // State serial number. Required.
}

type File struct {
	Version          int
	TerraformVersion string `json:"terraform_version"`
	Serial           int64
	Lineage          string
	Outputs          map[string]FileOutput
	Resources        []Resource
}

type FileOutput struct {
	Value     json.RawMessage
	Sensitive bool
}

type Options struct {
	logr.Logger
	html.Renderer

	WorkspaceAuthorizer internal.Authorizer

	internal.Cache
	workspace.WorkspaceService
	*sql.DB
	*tfeapi.Responder
	*surl.Signer
}

type Output struct {
	ID             string
	Name           string
	Type           string
	Value          json.RawMessage
	Sensitive      bool
	StateVersionID string
}

type Resource struct {
	Name        string
	ProviderURI string `json:"provider"`
	Type        string
	Module      string
}

type Service interface {
	// CreateStateVersion creates a state version for a workspace,
	// optionally including the state data, or uploading it later using
	// UploadStateVersion.
	CreateStateVersion(ctx context.Context, opts CreateStateVersionOptions) (*Version, error)
	// DownloadCurrentState downloads the current (latest) state for the given
	// workspace.
	DownloadCurrentState(ctx context.Context, workspaceID string) ([]byte, error)
	ListStateVersions(ctx context.Context, workspaceID string, opts resource.PageOptions) (*resource.Page[*Version], error)
	GetCurrentStateVersion(ctx context.Context, workspaceID string) (*Version, error)
	GetStateVersion(ctx context.Context, versionID string) (*Version, error)
	DeleteStateVersion(ctx context.Context, versionID string) error
	// RollbackStateVersion creates a state version by duplicating the
	// specified state version and sets it as the current state version for
	// the given workspace.
	RollbackStateVersion(ctx context.Context, versionID string) (*Version, error)
	// UploadState uploads the state data for a state version.
	UploadState(ctx context.Context, versionID string, state []byte) error
	// DownloadState downloads the state data for a state version.
	DownloadState(ctx context.Context, versionID string) ([]byte, error)
	GetStateVersionOutput(ctx context.Context, outputID string) (*Output, error)
}

type StateService = Service

type StateVersionListOptions struct {
	resource.PageOptions
	Organization string `schema:"filter[organization][name],required"`
	Workspace    string `schema:"filter[workspace][name],required"`
}

type Status string

type Version struct {
	ID          string             `jsonapi:"primary,state-versions"`
	CreatedAt   time.Time          `jsonapi:"attribute" json:"created-at"`
	Serial      int64              `jsonapi:"attribute" json:"serial"`
	State       []byte             `jsonapi:"attribute" json:"state"`
	Status      Status             `jsonapi:"attribute" json:"status"`
	Outputs     map[string]*Output `jsonapi:"attribute" json:"outputs"`
	WorkspaceID string             `jsonapi:"attribute" json:"workspace-id"`
}