state

type Client struct {
	otf.JSONAPIClient
}

type CreateStateVersionOptions struct {
	State       []byte  // Terraform state file. Required.
	WorkspaceID *string // ID of state version's workspace. Required.
	Serial      *int64  // State serial number. If not provided then it is extracted from the state.
}

type File struct {
	Version int
	Serial  int64
	Lineage string
	Outputs map[string]FileOutput
}

type FileOutput struct {
	Value     json.RawMessage
	Sensitive bool
}

type Options struct {
	logr.Logger

	WorkspaceService
	WorkspaceAuthorizer otf.Authorizer

	otf.Cache
	otf.DB
}

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

type Service interface {
	// CreateStateVersion creates a state version for the given workspace using
	// the given state data.
	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, opts StateVersionListOptions) (*VersionList, error)
	GetCurrentStateVersion(ctx context.Context, workspaceID string) (*Version, error)
	GetStateVersion(ctx context.Context, versionID string) (*Version, 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)
	DownloadState(ctx context.Context, versionID string) ([]byte, error)
	GetStateVersionOutput(ctx context.Context, outputID string) (*Output, error)
}

type StateService = Service

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

type Version struct {
	ID          string
	CreatedAt   time.Time
	Serial      int64
	State       []byte     // state file
	Outputs     outputList // state version has many outputs
	WorkspaceID string     // state version belongs to a workspace
}

type VersionList struct {
	*otf.Pagination
	Items []*Version
}

type WorkspaceService = workspace.Service