state

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

type ChangeAction string

type Client struct {
	*otfhttp.Client
}

type CreateStateVersionOptions struct {
	State       []byte         // Terraform state file. Optional.
	WorkspaceID resource.TfeID // 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
	internal.Cache
	*sql.DB
	*tfeapi.Responder
	*surl.Signer

	WorkspaceService *workspace.Service
	Authorizer       *authz.Authorizer
}

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

type OutputChange struct {
	Action ChangeAction
	Name   string
	Old    *FileOutput
	New    *FileOutput
}

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

type ResourceChange struct {
	Action   ChangeAction
	Resource Resource
}

type Service struct {
	logr.Logger

	*authz.Authorizer
	// contains filtered or unexported fields
}

type StateDiff struct {
	Resources []ResourceChange
	Outputs   []OutputChange
}

type Status string

type TFERollbackStateVersionOptions struct {
	// Type is a public field utilized by JSON:API to
	// set the resource type via the field tag.
	// It is not a user-defined value and does not need to be set.
	// https://jsonapi.org/format/#crud-creating
	Type string `jsonapi:"primary,state-versions"`
	// Specifies state version to rollback to. Only its ID is specified.
	RollbackStateVersion *TFEStateVersion `jsonapi:"relationship" json:"state-version"`
}

type TFEStateVersion struct {
	ID                 resource.TfeID        `jsonapi:"primary,state-versions"`
	CreatedAt          time.Time             `jsonapi:"attribute" json:"created-at"`
	DownloadURL        string                `jsonapi:"attribute" json:"hosted-state-download-url"`
	UploadURL          string                `jsonapi:"attribute" json:"hosted-state-upload-url"`
	JSONUploadURL      string                `jsonapi:"attribute" json:"hosted-json-state-upload-url"`
	Status             TFEStateVersionStatus `jsonapi:"attribute" json:"status"`
	Serial             int64                 `jsonapi:"attribute" json:"serial"`
	VCSCommitSHA       string                `jsonapi:"attribute" json:"vcs-commit-sha"`
	ResourcesProcessed bool                  `jsonapi:"attribute" json:"resources-processed"`
	StateVersion       int                   `jsonapi:"attribute" json:"state-version"`
	TerraformVersion   string                `jsonapi:"attribute" json:"terraform-version"`

	// Relations
	Outputs []*TFEStateVersionOutput `jsonapi:"relationship" json:"outputs"`
}

type TFEStateVersionCreateVersionOptions struct {
	// Type is a public field utilized by JSON:API to
	// set the resource type via the field tag.
	// It is not a user-defined value and does not need to be set.
	// https://jsonapi.org/format/#crud-creating
	Type string `jsonapi:"primary,state-versions"`
	// The lineage of the state.
	Lineage *string `jsonapi:"attribute" json:"lineage,omitempty"`
	// The MD5 hash of the state version.
	MD5 *string `jsonapi:"attribute" json:"md5"`
	// The serial of the state.
	Serial *int64 `jsonapi:"attribute" json:"serial"`
	// The base64 encoded state.
	State *string `jsonapi:"attribute" json:"state"`
	// Force can be set to skip certain validations. Wrong use of this flag can
	// cause data loss, so USE WITH CAUTION!
	Force *bool `jsonapi:"attribute" json:"force"`
}

type TFEStateVersionList struct {
	*types.Pagination
	Items []*TFEStateVersion
}

type TFEStateVersionOutput struct {
	ID        resource.TfeID `jsonapi:"primary,state-version-outputs"`
	Name      string         `jsonapi:"attribute" json:"name"`
	Sensitive bool           `jsonapi:"attribute" json:"sensitive"`
	Type      string         `jsonapi:"attribute" json:"type"`
	Value     any            `jsonapi:"attribute" json:"value"`
}

type TFEStateVersionStatus string

type Version struct {
	ID          resource.TfeID     `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 resource.TfeID     `jsonapi:"attribute" json:"workspace-id"`
}