json

Documentation

Overview

This is derived from terraform b4a634ced88673d4d208ddee41f39666f51cd133

Index

• Constants
• type ChangeAction
• type ChangeReason
• type ChangeSummary
• type Diagnostic
• type DiagnosticExpressionValue
• type DiagnosticFunctionCall
• type DiagnosticRange
• type DiagnosticSnippet
• type Function
• type FunctionParam
• type Hook
• type Importing
• type MessageType
• type Operation
• type OperationComplete
• type OperationErrored
• type OperationProgress
• type OperationStart
• type Output
• type Outputs
• type Pos
• type ProvisionComplete
• type ProvisionErrored
• type ProvisionProgress
• type ProvisionStart
• type RefreshComplete
• type RefreshStart
• type ResourceAddr
• type ResourceInstanceChange

Constants

const (
	DiagnosticSeverityUnknown = "unknown"
	DiagnosticSeverityError   = "error"
	DiagnosticSeverityWarning = "warning"
)

Types

type ChangeAction

type ChangeAction string

const (
	ActionNoOp    ChangeAction = "noop"
	ActionMove    ChangeAction = "move"
	ActionForget  ChangeAction = "remove"
	ActionCreate  ChangeAction = "create"
	ActionRead    ChangeAction = "read"
	ActionUpdate  ChangeAction = "update"
	ActionReplace ChangeAction = "replace"
	ActionDelete  ChangeAction = "delete"
	ActionImport  ChangeAction = "import"

	// While ephemeral resources do not represent a change
	// or participate in the plan in the same way as the above
	// we declare them here for convenience in helper functions.
	ActionOpen  ChangeAction = "open"
	ActionRenew ChangeAction = "renew"
	ActionClose ChangeAction = "close"
)

type ChangeReason

type ChangeReason string

const (
	ReasonNone               ChangeReason = ""
	ReasonTainted            ChangeReason = "tainted"
	ReasonRequested          ChangeReason = "requested"
	ReasonReplaceTriggeredBy ChangeReason = "replace_triggered_by"
	ReasonCannotUpdate       ChangeReason = "cannot_update"
	ReasonUnknown            ChangeReason = "unknown"

	ReasonDeleteBecauseNoResourceConfig ChangeReason = "delete_because_no_resource_config"
	ReasonDeleteBecauseWrongRepetition  ChangeReason = "delete_because_wrong_repetition"
	ReasonDeleteBecauseCountIndex       ChangeReason = "delete_because_count_index"
	ReasonDeleteBecauseEachKey          ChangeReason = "delete_because_each_key"
	ReasonDeleteBecauseNoModule         ChangeReason = "delete_because_no_module"
	ReasonDeleteBecauseNoMoveTarget     ChangeReason = "delete_because_no_move_target"
	ReasonReadBecauseConfigUnknown      ChangeReason = "read_because_config_unknown"
	ReasonReadBecauseDependencyPending  ChangeReason = "read_because_dependency_pending"
	ReasonReadBecauseCheckNested        ChangeReason = "read_because_check_nested"
)

type ChangeSummary

type ChangeSummary struct {
	Add       int       `json:"add"`
	Change    int       `json:"change"`
	Import    int       `json:"import"`
	Remove    int       `json:"remove"`
	Operation Operation `json:"operation"`
}

type Diagnostic

type Diagnostic struct {
	Severity string             `json:"severity"`
	Summary  string             `json:"summary"`
	Detail   string             `json:"detail"`
	Address  string             `json:"address,omitempty"`
	Range    *DiagnosticRange   `json:"range,omitempty"`
	Snippet  *DiagnosticSnippet `json:"snippet,omitempty"`
}

type DiagnosticExpressionValue

type DiagnosticExpressionValue struct {
	Traversal string `json:"traversal"`
	Statement string `json:"statement"`
}

type DiagnosticFunctionCall

type DiagnosticFunctionCall struct {
	CalledAs  string    `json:"called_as"`
	Signature *Function `json:"signature,omitempty"`
}

type DiagnosticRange

type DiagnosticRange struct {
	Filename string `json:"filename"`
	Start    Pos    `json:"start"`
	End      Pos    `json:"end"`
}

type DiagnosticSnippet

type DiagnosticSnippet struct {
	Context              *string                     `json:"context"`
	Code                 string                      `json:"code"`
	StartLine            int                         `json:"start_line"`
	HighlightStartOffset int                         `json:"highlight_start_offset"`
	HighlightEndOffset   int                         `json:"highlight_end_offset"`
	Values               []DiagnosticExpressionValue `json:"values"`
	FunctionCall         *DiagnosticFunctionCall     `json:"function_call,omitempty"`
}

type Function

type Function struct {
	Name            string          `json:"name"`
	Params          []FunctionParam `json:"params"`
	VariadicParam   *FunctionParam  `json:"variadic_param,omitempty"`
	ReturnType      json.RawMessage `json:"return_type"`
	Description     string          `json:"description,omitempty"`
	DescriptionKind string          `json:"description_kind,omitempty"`
}

type FunctionParam

type FunctionParam struct {
	Name            string          `json:"name"`
	Type            json.RawMessage `json:"type"`
	Description     string          `json:"description,omitempty"`
	DescriptionKind string          `json:"description_kind,omitempty"`
}

type Hook

type Hook interface {
	// contains filtered or unexported methods
}

type Importing

type Importing struct {
	ID string `json:"id,omitempty"`
}

type MessageType

type MessageType string

const (
	// Generic messages
	MessageVersion    MessageType = "version"
	MessageLog        MessageType = "log"
	MessageDiagnostic MessageType = "diagnostic"

	// Operation results
	MessageResourceDrift MessageType = "resource_drift"
	MessagePlannedChange MessageType = "planned_change"
	MessageChangeSummary MessageType = "change_summary"
	MessageOutputs       MessageType = "outputs"

	// Hook-driven messages
	MessageApplyStart        MessageType = "apply_start"
	MessageApplyProgress     MessageType = "apply_progress"
	MessageApplyComplete     MessageType = "apply_complete"
	MessageApplyErrored      MessageType = "apply_errored"
	MessageProvisionStart    MessageType = "provision_start"
	MessageProvisionProgress MessageType = "provision_progress"
	MessageProvisionComplete MessageType = "provision_complete"
	MessageProvisionErrored  MessageType = "provision_errored"
	MessageRefreshStart      MessageType = "refresh_start"
	MessageRefreshComplete   MessageType = "refresh_complete"
	// Ephemeral operation messages
	MessageEphemeralOpStart    MessageType = "ephemeral_op_start"
	MessageEphemeralOpProgress MessageType = "ephemeral_op_progress"
	MessageEphemeralOpComplete MessageType = "ephemeral_op_complete"
	MessageEphemeralOpErrored  MessageType = "ephemeral_op_errored"

	// Test messages
	MessageTestAbstract  MessageType = "test_abstract"
	MessageTestFile      MessageType = "test_file"
	MessageTestRun       MessageType = "test_run"
	MessageTestPlan      MessageType = "test_plan"
	MessageTestState     MessageType = "test_state"
	MessageTestSummary   MessageType = "test_summary"
	MessageTestCleanup   MessageType = "test_cleanup"
	MessageTestInterrupt MessageType = "test_interrupt"
	MessageTestStatus    MessageType = "test_status"
	MessageTestRetry     MessageType = "test_retry"
)

type Operation

type Operation string

const (
	OperationApplied   Operation = "apply"
	OperationDestroyed Operation = "destroy"
	OperationPlanned   Operation = "plan"
)

type OperationComplete

type OperationComplete struct {
	Resource ResourceAddr `json:"resource"`
	Action   ChangeAction `json:"action"`
	IDKey    string       `json:"id_key,omitempty"`
	IDValue  string       `json:"id_value,omitempty"`
	Elapsed  float64      `json:"elapsed_seconds"`
	// contains filtered or unexported fields
}

OperationComplete: triggered by PostApply hook msgType can be: - MessageApplyComplete - MessageEphemeralOpComplete

type OperationErrored

type OperationErrored struct {
	Resource ResourceAddr `json:"resource"`
	Action   ChangeAction `json:"action"`
	Elapsed  float64      `json:"elapsed_seconds"`
	// contains filtered or unexported fields
}

OperationErrored: triggered by PostApply hook on failure. This will be followed by diagnostics when the apply finishes. msgType can be: - MessageApplyErrored - MessageEphemeralOpErrored

type OperationProgress

type OperationProgress struct {
	Resource ResourceAddr `json:"resource"`
	Action   ChangeAction `json:"action"`
	Elapsed  float64      `json:"elapsed_seconds"`
	// contains filtered or unexported fields
}

OperationProgress: currently triggered by a timer started on Pre{Apply,EphemeralOp}. In future, this might also be triggered by provider progress reporting. msgType can be: - MessageApplyProgress - MessageEphemeralOpProgress

type OperationStart

type OperationStart struct {
	Resource ResourceAddr `json:"resource"`
	Action   ChangeAction `json:"action"`
	IDKey    string       `json:"id_key,omitempty"`
	IDValue  string       `json:"id_value,omitempty"`
	// contains filtered or unexported fields
}

OperationStart: triggered by Pre{Apply,EphemeralOp} hook msgType can be: - MessageApplyStart - MessageEphemeralOpStart

type Output

type Output struct {
	Sensitive bool            `json:"sensitive"`
	Type      string          `json:"type,omitempty"`
	Value     json.RawMessage `json:"value,omitempty"`
	Action    ChangeAction    `json:"action,omitempty"`
}

type Outputs

type Outputs map[string]Output

type Pos

type Pos struct {
	Line   int `json:"line"`
	Column int `json:"column"`
	Byte   int `json:"byte"`
}

type ProvisionComplete

type ProvisionComplete struct {
	Resource    ResourceAddr `json:"resource"`
	Provisioner string       `json:"provisioner"`
	// contains filtered or unexported fields
}

ProvisionComplete: triggered by PostProvisionInstanceStep hook msgType can be: - MessageProvisionComplete

type ProvisionErrored

type ProvisionErrored struct {
	Resource    ResourceAddr `json:"resource"`
	Provisioner string       `json:"provisioner"`
	// contains filtered or unexported fields
}

ProvisionErrored: triggered by PostProvisionInstanceStep hook on failure. This will be followed by diagnostics when the apply finishes. msgType can be: - MessageProvisionErrored

type ProvisionProgress

type ProvisionProgress struct {
	Resource    ResourceAddr `json:"resource"`
	Provisioner string       `json:"provisioner"`
	Output      string       `json:"output"`
	// contains filtered or unexported fields
}

ProvisionProgress: triggered by ProvisionOutput hook msgType can be: - MessageProvisionProgress

type ProvisionStart

type ProvisionStart struct {
	Resource    ResourceAddr `json:"resource"`
	Provisioner string       `json:"provisioner"`
	// contains filtered or unexported fields
}

ProvisionStart: triggered by PreProvisionInstanceStep hook msgType can be: - MessageProvisionStart

type RefreshComplete

type RefreshComplete struct {
	Resource ResourceAddr `json:"resource"`
	IDKey    string       `json:"id_key,omitempty"`
	IDValue  string       `json:"id_value,omitempty"`
	// contains filtered or unexported fields
}

RefreshComplete: triggered by PostRefresh hook msgType can be: - MessageRefreshComplete

type RefreshStart

type RefreshStart struct {
	Resource ResourceAddr `json:"resource"`
	IDKey    string       `json:"id_key,omitempty"`
	IDValue  string       `json:"id_value,omitempty"`
	// contains filtered or unexported fields
}

RefreshStart: triggered by PreRefresh hook msgType can be: - MessageRefreshStart

type ResourceAddr

type ResourceAddr struct {
	Addr            string                  `json:"addr"`
	Module          string                  `json:"module"`
	Resource        string                  `json:"resource"`
	ImpliedProvider string                  `json:"implied_provider"`
	ResourceType    string                  `json:"resource_type"`
	ResourceName    string                  `json:"resource_name"`
	ResourceKey     ctyjson.SimpleJSONValue `json:"resource_key"`
}

type ResourceInstanceChange

type ResourceInstanceChange struct {
	Resource         ResourceAddr  `json:"resource"`
	PreviousResource *ResourceAddr `json:"previous_resource,omitempty"`
	Action           ChangeAction  `json:"action"`
	Reason           ChangeReason  `json:"reason,omitempty"`
	Importing        *Importing    `json:"importing,omitempty"`
	GeneratedConfig  string        `json:"generated_config,omitempty"`
}