planproto

package
v1.3.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 4, 2023 License: MPL-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package planproto is home to the Go stubs generated from the tfplan protobuf schema.

This is an internal package to be used only by Terraform's planfile package. From elsewhere in Terraform, use the API exported by the planfile package itself.

Index

Constants

This section is empty.

Variables

View Source 
var (
	Mode_name = map[int32]string{
		0: "NORMAL",
		1: "DESTROY",
		2: "REFRESH_ONLY",
	}
	Mode_value = map[string]int32{
		"NORMAL":       0,
		"DESTROY":      1,
		"REFRESH_ONLY": 2,
	}
)

Enum value maps for Mode.

View Source 
var (
	Action_name = map[int32]string{
		0: "NOOP",
		1: "CREATE",
		2: "READ",
		3: "UPDATE",
		5: "DELETE",
		6: "DELETE_THEN_CREATE",
		7: "CREATE_THEN_DELETE",
	}
	Action_value = map[string]int32{
		"NOOP":               0,
		"CREATE":             1,
		"READ":               2,
		"UPDATE":             3,
		"DELETE":             5,
		"DELETE_THEN_CREATE": 6,
		"CREATE_THEN_DELETE": 7,
	}
)

Enum value maps for Action.

View Source 
var (
	ResourceInstanceActionReason_name = map[int32]string{
		0:  "NONE",
		1:  "REPLACE_BECAUSE_TAINTED",
		2:  "REPLACE_BY_REQUEST",
		3:  "REPLACE_BECAUSE_CANNOT_UPDATE",
		4:  "DELETE_BECAUSE_NO_RESOURCE_CONFIG",
		5:  "DELETE_BECAUSE_WRONG_REPETITION",
		6:  "DELETE_BECAUSE_COUNT_INDEX",
		7:  "DELETE_BECAUSE_EACH_KEY",
		8:  "DELETE_BECAUSE_NO_MODULE",
		9:  "REPLACE_BY_TRIGGERS",
		10: "READ_BECAUSE_CONFIG_UNKNOWN",
		11: "READ_BECAUSE_DEPENDENCY_PENDING",
		12: "DELETE_BECAUSE_NO_MOVE_TARGET",
	}
	ResourceInstanceActionReason_value = map[string]int32{
		"NONE":                              0,
		"REPLACE_BECAUSE_TAINTED":           1,
		"REPLACE_BY_REQUEST":                2,
		"REPLACE_BECAUSE_CANNOT_UPDATE":     3,
		"DELETE_BECAUSE_NO_RESOURCE_CONFIG": 4,
		"DELETE_BECAUSE_WRONG_REPETITION":   5,
		"DELETE_BECAUSE_COUNT_INDEX":        6,
		"DELETE_BECAUSE_EACH_KEY":           7,
		"DELETE_BECAUSE_NO_MODULE":          8,
		"REPLACE_BY_TRIGGERS":               9,
		"READ_BECAUSE_CONFIG_UNKNOWN":       10,
		"READ_BECAUSE_DEPENDENCY_PENDING":   11,
		"DELETE_BECAUSE_NO_MOVE_TARGET":     12,
	}
)

Enum value maps for ResourceInstanceActionReason.

View Source 
var (
	CheckResults_Status_name = map[int32]string{
		0: "UNKNOWN",
		1: "PASS",
		2: "FAIL",
		3: "ERROR",
	}
	CheckResults_Status_value = map[string]int32{
		"UNKNOWN": 0,
		"PASS":    1,
		"FAIL":    2,
		"ERROR":   3,
	}
)

Enum value maps for CheckResults_Status.

View Source 
var (
	CheckResults_ObjectKind_name = map[int32]string{
		0: "UNSPECIFIED",
		1: "RESOURCE",
		2: "OUTPUT_VALUE",
	}
	CheckResults_ObjectKind_value = map[string]int32{
		"UNSPECIFIED":  0,
		"RESOURCE":     1,
		"OUTPUT_VALUE": 2,
	}
)

Enum value maps for CheckResults_ObjectKind.

View Source 
var File_planfile_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Action 

type Action int32

Action describes the type of action planned for an object. Not all action values are valid for all object types. 

const (
	Action_NOOP               Action = 0
	Action_CREATE             Action = 1
	Action_READ               Action = 2
	Action_UPDATE             Action = 3
	Action_DELETE             Action = 5
	Action_DELETE_THEN_CREATE Action = 6
	Action_CREATE_THEN_DELETE Action = 7
)

func (Action) Descriptor 

func (Action) Descriptor() protoreflect.EnumDescriptor

func (Action) Enum 

func (x Action) Enum() *Action

func (Action) EnumDescriptor deprecated 

func (Action) EnumDescriptor() ([]byte, []int)

Deprecated: Use Action.Descriptor instead.

func (Action) Number 

func (x Action) Number() protoreflect.EnumNumber

func (Action) String 

func (x Action) String() string

func (Action) Type 

func (Action) Type() protoreflect.EnumType

type Backend 

type Backend struct {
	Type      string        `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	Config    *DynamicValue `protobuf:"bytes,2,opt,name=config,proto3" json:"config,omitempty"`
	Workspace string        `protobuf:"bytes,3,opt,name=workspace,proto3" json:"workspace,omitempty"`
	// contains filtered or unexported fields
}

Backend is a description of backend configuration and other related settings.

func (*Backend) Descriptor deprecated 

func (*Backend) Descriptor() ([]byte, []int)

Deprecated: Use Backend.ProtoReflect.Descriptor instead.

func (*Backend) GetConfig 

func (x *Backend) GetConfig() *DynamicValue

func (*Backend) GetType 

func (x *Backend) GetType() string

func (*Backend) GetWorkspace 

func (x *Backend) GetWorkspace() string

func (*Backend) ProtoMessage 

func (*Backend) ProtoMessage()

func (*Backend) ProtoReflect 

func (x *Backend) ProtoReflect() protoreflect.Message

func (*Backend) Reset 

func (x *Backend) Reset()

func (*Backend) String 

func (x *Backend) String() string

type Change 

type Change struct {

	// Not all action values are valid for all object types. Consult
	// the documentation for any message that embeds Change.
	Action Action `protobuf:"varint,1,opt,name=action,proto3,enum=tfplan.Action" json:"action,omitempty"`
	// msgpack-encoded HCL values involved in the change.
	//   - For update and replace, two values are provided that give the old and new values,
	//     respectively.
	//   - For create, one value is provided that gives the new value to be created
	//   - For delete, one value is provided that describes the value being deleted
	//   - For read, two values are provided that give the prior value for this object
	//     (or null, if no prior value exists) and the value that was or will be read,
	//     respectively.
	//   - For no-op, one value is provided that is left unmodified by this non-change.
	Values []*DynamicValue `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"`
	// An unordered set of paths into the old value which are marked as
	// sensitive. Values at these paths should be obscured in human-readable
	// output. This set is always empty for create.
	BeforeSensitivePaths []*Path `protobuf:"bytes,3,rep,name=before_sensitive_paths,json=beforeSensitivePaths,proto3" json:"before_sensitive_paths,omitempty"`
	// An unordered set of paths into the new value which are marked as
	// sensitive. Values at these paths should be obscured in human-readable
	// output. This set is always empty for delete.
	AfterSensitivePaths []*Path `protobuf:"bytes,4,rep,name=after_sensitive_paths,json=afterSensitivePaths,proto3" json:"after_sensitive_paths,omitempty"`
	// contains filtered or unexported fields
}

Change represents a change made to some object, transforming it from an old state to a new state.

func (*Change) Descriptor deprecated 

func (*Change) Descriptor() ([]byte, []int)

Deprecated: Use Change.ProtoReflect.Descriptor instead.

func (*Change) GetAction 

func (x *Change) GetAction() Action

func (*Change) GetAfterSensitivePaths 

func (x *Change) GetAfterSensitivePaths() []*Path

func (*Change) GetBeforeSensitivePaths 

func (x *Change) GetBeforeSensitivePaths() []*Path

func (*Change) GetValues 

func (x *Change) GetValues() []*DynamicValue

func (*Change) ProtoMessage 

func (*Change) ProtoMessage()

func (*Change) ProtoReflect 

func (x *Change) ProtoReflect() protoreflect.Message

func (*Change) Reset 

func (x *Change) Reset()

func (*Change) String 

func (x *Change) String() string

type CheckResults added in v1.3.0 

type CheckResults struct {
	Kind CheckResults_ObjectKind `protobuf:"varint,1,opt,name=kind,proto3,enum=tfplan.CheckResults_ObjectKind" json:"kind,omitempty"`
	// Address of the configuration object that declared the checks.
	ConfigAddr string `protobuf:"bytes,2,opt,name=config_addr,json=configAddr,proto3" json:"config_addr,omitempty"`
	// The aggregate status of the entire configuration object, based on
	// the statuses of its zero or more checkable objects.
	Status CheckResults_Status `protobuf:"varint,3,opt,name=status,proto3,enum=tfplan.CheckResults_Status" json:"status,omitempty"`
	// The results for individual objects that were declared by the
	// configuration object named in config_addr.
	Objects []*CheckResults_ObjectResult `protobuf:"bytes,4,rep,name=objects,proto3" json:"objects,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResults) Descriptor deprecated added in v1.3.0 

func (*CheckResults) Descriptor() ([]byte, []int)

Deprecated: Use CheckResults.ProtoReflect.Descriptor instead.

func (*CheckResults) GetConfigAddr added in v1.3.0 

func (x *CheckResults) GetConfigAddr() string

func (*CheckResults) GetKind added in v1.3.0 

func (x *CheckResults) GetKind() CheckResults_ObjectKind

func (*CheckResults) GetObjects added in v1.3.0 

func (x *CheckResults) GetObjects() []*CheckResults_ObjectResult

func (*CheckResults) GetStatus added in v1.3.0 

func (x *CheckResults) GetStatus() CheckResults_Status

func (*CheckResults) ProtoMessage added in v1.3.0 

func (*CheckResults) ProtoMessage()

func (*CheckResults) ProtoReflect added in v1.3.0 

func (x *CheckResults) ProtoReflect() protoreflect.Message

func (*CheckResults) Reset added in v1.3.0 

func (x *CheckResults) Reset()

func (*CheckResults) String added in v1.3.0 

func (x *CheckResults) String() string

type CheckResults_ObjectKind added in v1.3.0 

type CheckResults_ObjectKind int32
const (
	CheckResults_UNSPECIFIED  CheckResults_ObjectKind = 0
	CheckResults_RESOURCE     CheckResults_ObjectKind = 1
	CheckResults_OUTPUT_VALUE CheckResults_ObjectKind = 2
)

func (CheckResults_ObjectKind) Descriptor added in v1.3.0 

func (CheckResults_ObjectKind) Descriptor() protoreflect.EnumDescriptor

func (CheckResults_ObjectKind) Enum added in v1.3.0 

func (x CheckResults_ObjectKind) Enum() *CheckResults_ObjectKind

func (CheckResults_ObjectKind) EnumDescriptor deprecated added in v1.3.0 

func (CheckResults_ObjectKind) EnumDescriptor() ([]byte, []int)

Deprecated: Use CheckResults_ObjectKind.Descriptor instead.

func (CheckResults_ObjectKind) Number added in v1.3.0 

func (x CheckResults_ObjectKind) Number() protoreflect.EnumNumber

func (CheckResults_ObjectKind) String added in v1.3.0 

func (x CheckResults_ObjectKind) String() string

func (CheckResults_ObjectKind) Type added in v1.3.0 

func (CheckResults_ObjectKind) Type() protoreflect.EnumType

type CheckResults_ObjectResult added in v1.3.0 

type CheckResults_ObjectResult struct {
	ObjectAddr      string              `protobuf:"bytes,1,opt,name=object_addr,json=objectAddr,proto3" json:"object_addr,omitempty"`
	Status          CheckResults_Status `protobuf:"varint,2,opt,name=status,proto3,enum=tfplan.CheckResults_Status" json:"status,omitempty"`
	FailureMessages []string            `protobuf:"bytes,3,rep,name=failure_messages,json=failureMessages,proto3" json:"failure_messages,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResults_ObjectResult) Descriptor deprecated added in v1.3.0 

func (*CheckResults_ObjectResult) Descriptor() ([]byte, []int)

Deprecated: Use CheckResults_ObjectResult.ProtoReflect.Descriptor instead.

func (*CheckResults_ObjectResult) GetFailureMessages added in v1.3.0 

func (x *CheckResults_ObjectResult) GetFailureMessages() []string

func (*CheckResults_ObjectResult) GetObjectAddr added in v1.3.0 

func (x *CheckResults_ObjectResult) GetObjectAddr() string

func (*CheckResults_ObjectResult) GetStatus added in v1.3.0 

func (x *CheckResults_ObjectResult) GetStatus() CheckResults_Status

func (*CheckResults_ObjectResult) ProtoMessage added in v1.3.0 

func (*CheckResults_ObjectResult) ProtoMessage()

func (*CheckResults_ObjectResult) ProtoReflect added in v1.3.0 

func (x *CheckResults_ObjectResult) ProtoReflect() protoreflect.Message

func (*CheckResults_ObjectResult) Reset added in v1.3.0 

func (x *CheckResults_ObjectResult) Reset()

func (*CheckResults_ObjectResult) String added in v1.3.0 

func (x *CheckResults_ObjectResult) String() string

type CheckResults_Status added in v1.3.0 

type CheckResults_Status int32

Status describes the status of a particular checkable object at the completion of the plan. 

const (
	CheckResults_UNKNOWN CheckResults_Status = 0
	CheckResults_PASS    CheckResults_Status = 1
	CheckResults_FAIL    CheckResults_Status = 2
	CheckResults_ERROR   CheckResults_Status = 3
)

func (CheckResults_Status) Descriptor added in v1.3.0 

func (CheckResults_Status) Descriptor() protoreflect.EnumDescriptor

func (CheckResults_Status) Enum added in v1.3.0 

func (x CheckResults_Status) Enum() *CheckResults_Status

func (CheckResults_Status) EnumDescriptor deprecated added in v1.3.0 

func (CheckResults_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use CheckResults_Status.Descriptor instead.

func (CheckResults_Status) Number added in v1.3.0 

func (x CheckResults_Status) Number() protoreflect.EnumNumber

func (CheckResults_Status) String added in v1.3.0 

func (x CheckResults_Status) String() string

func (CheckResults_Status) Type added in v1.3.0 

func (CheckResults_Status) Type() protoreflect.EnumType

type DynamicValue 

type DynamicValue struct {
	Msgpack []byte `protobuf:"bytes,1,opt,name=msgpack,proto3" json:"msgpack,omitempty"`
	// contains filtered or unexported fields
}

DynamicValue represents a value whose type is not decided until runtime, often based on schema information obtained from a plugin.

At present dynamic values are always encoded as msgpack, with extension id 0 used to represent the special "unknown" value indicating results that won't be known until after apply.

In future other serialization formats may be used, possibly with a transitional period of including both as separate attributes of this type. Consumers must ignore attributes they don't support and fail if no supported attribute is present. The top-level format version will not be incremented for changes to the set of dynamic serialization formats.

func (*DynamicValue) Descriptor deprecated 

func (*DynamicValue) Descriptor() ([]byte, []int)

Deprecated: Use DynamicValue.ProtoReflect.Descriptor instead.

func (*DynamicValue) GetMsgpack 

func (x *DynamicValue) GetMsgpack() []byte

func (*DynamicValue) ProtoMessage 

func (*DynamicValue) ProtoMessage()

func (*DynamicValue) ProtoReflect 

func (x *DynamicValue) ProtoReflect() protoreflect.Message

func (*DynamicValue) Reset 

func (x *DynamicValue) Reset()

func (*DynamicValue) String 

func (x *DynamicValue) String() string

type Mode 

type Mode int32

Mode describes the planning mode that created the plan. 

const (
	Mode_NORMAL       Mode = 0
	Mode_DESTROY      Mode = 1
	Mode_REFRESH_ONLY Mode = 2
)

func (Mode) Descriptor 

func (Mode) Descriptor() protoreflect.EnumDescriptor

func (Mode) Enum 

func (x Mode) Enum() *Mode

func (Mode) EnumDescriptor deprecated 

func (Mode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Mode.Descriptor instead.

func (Mode) Number 

func (x Mode) Number() protoreflect.EnumNumber

func (Mode) String 

func (x Mode) String() string

func (Mode) Type 

func (Mode) Type() protoreflect.EnumType

type OutputChange 

type OutputChange struct {

	// Name of the output as defined in the root module.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Description of the proposed change. May use "no-op", "create",
	// "update" and "delete" actions.
	Change *Change `protobuf:"bytes,2,opt,name=change,proto3" json:"change,omitempty"`
	// Sensitive, if true, indicates that one or more of the values given
	// in "change" is sensitive and should not be shown directly in any
	// rendered plan.
	Sensitive bool `protobuf:"varint,3,opt,name=sensitive,proto3" json:"sensitive,omitempty"`
	// contains filtered or unexported fields
}

func (*OutputChange) Descriptor deprecated 

func (*OutputChange) Descriptor() ([]byte, []int)

Deprecated: Use OutputChange.ProtoReflect.Descriptor instead.

func (*OutputChange) GetChange 

func (x *OutputChange) GetChange() *Change

func (*OutputChange) GetName 

func (x *OutputChange) GetName() string

func (*OutputChange) GetSensitive 

func (x *OutputChange) GetSensitive() bool

func (*OutputChange) ProtoMessage 

func (*OutputChange) ProtoMessage()

func (*OutputChange) ProtoReflect 

func (x *OutputChange) ProtoReflect() protoreflect.Message

func (*OutputChange) Reset 

func (x *OutputChange) Reset()

func (*OutputChange) String 

func (x *OutputChange) String() string

type Path 

type Path struct {
	Steps []*Path_Step `protobuf:"bytes,1,rep,name=steps,proto3" json:"steps,omitempty"`
	// contains filtered or unexported fields
}

Path represents a set of steps to traverse into a data structure. It is used to refer to a sub-structure within a dynamic data structure presented separately.

func (*Path) Descriptor deprecated 

func (*Path) Descriptor() ([]byte, []int)

Deprecated: Use Path.ProtoReflect.Descriptor instead.

func (*Path) GetSteps 

func (x *Path) GetSteps() []*Path_Step

func (*Path) ProtoMessage 

func (*Path) ProtoMessage()

func (*Path) ProtoReflect 

func (x *Path) ProtoReflect() protoreflect.Message

func (*Path) Reset 

func (x *Path) Reset()

func (*Path) String 

func (x *Path) String() string

type Path_Step 

type Path_Step struct {

	// Types that are assignable to Selector:
	//
	//	*Path_Step_AttributeName
	//	*Path_Step_ElementKey
	Selector isPath_Step_Selector `protobuf_oneof:"selector"`
	// contains filtered or unexported fields
}

func (*Path_Step) Descriptor deprecated 

func (*Path_Step) Descriptor() ([]byte, []int)

Deprecated: Use Path_Step.ProtoReflect.Descriptor instead.

func (*Path_Step) GetAttributeName 

func (x *Path_Step) GetAttributeName() string

func (*Path_Step) GetElementKey 

func (x *Path_Step) GetElementKey() *DynamicValue

func (*Path_Step) GetSelector 

func (m *Path_Step) GetSelector() isPath_Step_Selector

func (*Path_Step) ProtoMessage 

func (*Path_Step) ProtoMessage()

func (*Path_Step) ProtoReflect 

func (x *Path_Step) ProtoReflect() protoreflect.Message

func (*Path_Step) Reset 

func (x *Path_Step) Reset()

func (*Path_Step) String 

func (x *Path_Step) String() string

type Path_Step_AttributeName 

type Path_Step_AttributeName struct {
	// Set "attribute_name" to represent looking up an attribute
	// in the current object value.
	AttributeName string `protobuf:"bytes,1,opt,name=attribute_name,json=attributeName,proto3,oneof"`
}

type Path_Step_ElementKey 

type Path_Step_ElementKey struct {
	// Set "element_key" to represent looking up an element in
	// an indexable collection type.
	ElementKey *DynamicValue `protobuf:"bytes,2,opt,name=element_key,json=elementKey,proto3,oneof"`
}

type Plan 

type Plan struct {

	// Version is incremented whenever there is a breaking change to
	// the serialization format. Programs reading serialized plans should
	// verify that version is set to the expected value and abort processing
	// if not. A breaking change is any change that may cause an older
	// consumer to interpret the structure incorrectly. This number will
	// not be incremented if an existing consumer can either safely ignore
	// changes to the format or if an existing consumer would fail to process
	// the file for another message- or field-specific reason.
	Version uint64 `protobuf:"varint,1,opt,name=version,proto3" json:"version,omitempty"`
	// The mode that was active when this plan was created.
	//
	// This is saved only for UI purposes, so that Terraform can tailor its
	// rendering of the plan depending on the mode. This must never be used to
	// make decisions in Terraform Core during the applying of a plan.
	UiMode Mode `protobuf:"varint,17,opt,name=ui_mode,json=uiMode,proto3,enum=tfplan.Mode" json:"ui_mode,omitempty"`
	// The variables that were set when creating the plan. Each value is
	// a msgpack serialization of an HCL value.
	Variables map[string]*DynamicValue `` /* 159-byte string literal not displayed */
	// An unordered set of proposed changes to resources throughout the
	// configuration, including any nested modules. Use the address of
	// each resource to determine which module it belongs to.
	ResourceChanges []*ResourceInstanceChange `protobuf:"bytes,3,rep,name=resource_changes,json=resourceChanges,proto3" json:"resource_changes,omitempty"`
	// An unordered set of detected drift: changes made to resources outside of
	// Terraform, computed by comparing the previous run's state to the state
	// after refresh.
	ResourceDrift []*ResourceInstanceChange `protobuf:"bytes,18,rep,name=resource_drift,json=resourceDrift,proto3" json:"resource_drift,omitempty"`
	// An unordered set of proposed changes to outputs in the root module
	// of the configuration. This set also includes "no action" changes for
	// outputs that are not changing, as context for detecting inconsistencies
	// at apply time.
	OutputChanges []*OutputChange `protobuf:"bytes,4,rep,name=output_changes,json=outputChanges,proto3" json:"output_changes,omitempty"`
	// An unordered set of check results for the entire configuration.
	//
	// Each element represents a single static configuration object that has
	// checks, and each of those may have zero or more dynamic objects that
	// the checks were applied to nested within.
	CheckResults []*CheckResults `protobuf:"bytes,19,rep,name=check_results,json=checkResults,proto3" json:"check_results,omitempty"`
	// An unordered set of target addresses to include when applying. If no
	// target addresses are present, the plan applies to the whole
	// configuration.
	TargetAddrs []string `protobuf:"bytes,5,rep,name=target_addrs,json=targetAddrs,proto3" json:"target_addrs,omitempty"`
	// An unordered set of force-replace addresses to include when applying.
	// This must match the set of addresses that was used when creating the
	// plan, or else applying the plan will fail when it reaches a different
	// conclusion about what action a particular resource instance needs.
	ForceReplaceAddrs []string `protobuf:"bytes,16,rep,name=force_replace_addrs,json=forceReplaceAddrs,proto3" json:"force_replace_addrs,omitempty"`
	// The version string for the Terraform binary that created this plan.
	TerraformVersion string `protobuf:"bytes,14,opt,name=terraform_version,json=terraformVersion,proto3" json:"terraform_version,omitempty"`
	// Backend is a description of the backend configuration and other related
	// settings at the time the plan was created.
	Backend *Backend `protobuf:"bytes,13,opt,name=backend,proto3" json:"backend,omitempty"`
	// RelevantAttributes lists individual resource attributes from
	// ResourceDrift which may have contributed to the plan changes.
	RelevantAttributes []*PlanResourceAttr `protobuf:"bytes,15,rep,name=relevant_attributes,json=relevantAttributes,proto3" json:"relevant_attributes,omitempty"`
	// contains filtered or unexported fields
}

Plan is the root message type for the tfplan file

func (*Plan) Descriptor deprecated 

func (*Plan) Descriptor() ([]byte, []int)

Deprecated: Use Plan.ProtoReflect.Descriptor instead.

func (*Plan) GetBackend 

func (x *Plan) GetBackend() *Backend

func (*Plan) GetCheckResults added in v1.3.0 

func (x *Plan) GetCheckResults() []*CheckResults

func (*Plan) GetForceReplaceAddrs 

func (x *Plan) GetForceReplaceAddrs() []string

func (*Plan) GetOutputChanges 

func (x *Plan) GetOutputChanges() []*OutputChange

func (*Plan) GetRelevantAttributes added in v1.2.0 

func (x *Plan) GetRelevantAttributes() []*PlanResourceAttr

func (*Plan) GetResourceChanges 

func (x *Plan) GetResourceChanges() []*ResourceInstanceChange

func (*Plan) GetResourceDrift added in v1.1.0 

func (x *Plan) GetResourceDrift() []*ResourceInstanceChange

func (*Plan) GetTargetAddrs 

func (x *Plan) GetTargetAddrs() []string

func (*Plan) GetTerraformVersion 

func (x *Plan) GetTerraformVersion() string

func (*Plan) GetUiMode 

func (x *Plan) GetUiMode() Mode

func (*Plan) GetVariables 

func (x *Plan) GetVariables() map[string]*DynamicValue

func (*Plan) GetVersion 

func (x *Plan) GetVersion() uint64

func (*Plan) ProtoMessage 

func (*Plan) ProtoMessage()

func (*Plan) ProtoReflect 

func (x *Plan) ProtoReflect() protoreflect.Message

func (*Plan) Reset 

func (x *Plan) Reset()

func (*Plan) String 

func (x *Plan) String() string

type PlanResourceAttr added in v1.2.0 

type PlanResourceAttr struct {
	Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	Attr     *Path  `protobuf:"bytes,2,opt,name=attr,proto3" json:"attr,omitempty"`
	// contains filtered or unexported fields
}

func (*PlanResourceAttr) Descriptor deprecated added in v1.2.0 

func (*PlanResourceAttr) Descriptor() ([]byte, []int)

Deprecated: Use PlanResourceAttr.ProtoReflect.Descriptor instead.

func (*PlanResourceAttr) GetAttr added in v1.2.0 

func (x *PlanResourceAttr) GetAttr() *Path

func (*PlanResourceAttr) GetResource added in v1.2.0 

func (x *PlanResourceAttr) GetResource() string

func (*PlanResourceAttr) ProtoMessage added in v1.2.0 

func (*PlanResourceAttr) ProtoMessage()

func (*PlanResourceAttr) ProtoReflect added in v1.2.0 

func (x *PlanResourceAttr) ProtoReflect() protoreflect.Message

func (*PlanResourceAttr) Reset added in v1.2.0 

func (x *PlanResourceAttr) Reset()

func (*PlanResourceAttr) String added in v1.2.0 

func (x *PlanResourceAttr) String() string

type ResourceInstanceActionReason 

type ResourceInstanceActionReason int32

ResourceInstanceActionReason sometimes provides some additional user-facing context for why a particular action was chosen for a resource instance. This is for user feedback only and never used to drive behavior during the subsequent apply step. 

const (
	ResourceInstanceActionReason_NONE                              ResourceInstanceActionReason = 0
	ResourceInstanceActionReason_REPLACE_BECAUSE_TAINTED           ResourceInstanceActionReason = 1
	ResourceInstanceActionReason_REPLACE_BY_REQUEST                ResourceInstanceActionReason = 2
	ResourceInstanceActionReason_REPLACE_BECAUSE_CANNOT_UPDATE     ResourceInstanceActionReason = 3
	ResourceInstanceActionReason_DELETE_BECAUSE_NO_RESOURCE_CONFIG ResourceInstanceActionReason = 4
	ResourceInstanceActionReason_DELETE_BECAUSE_WRONG_REPETITION   ResourceInstanceActionReason = 5
	ResourceInstanceActionReason_DELETE_BECAUSE_COUNT_INDEX        ResourceInstanceActionReason = 6
	ResourceInstanceActionReason_DELETE_BECAUSE_EACH_KEY           ResourceInstanceActionReason = 7
	ResourceInstanceActionReason_DELETE_BECAUSE_NO_MODULE          ResourceInstanceActionReason = 8
	ResourceInstanceActionReason_REPLACE_BY_TRIGGERS               ResourceInstanceActionReason = 9
	ResourceInstanceActionReason_READ_BECAUSE_CONFIG_UNKNOWN       ResourceInstanceActionReason = 10
	ResourceInstanceActionReason_READ_BECAUSE_DEPENDENCY_PENDING   ResourceInstanceActionReason = 11
	ResourceInstanceActionReason_DELETE_BECAUSE_NO_MOVE_TARGET     ResourceInstanceActionReason = 12
)

func (ResourceInstanceActionReason) Descriptor 

func (ResourceInstanceActionReason) Descriptor() protoreflect.EnumDescriptor

func (ResourceInstanceActionReason) Enum 

func (x ResourceInstanceActionReason) Enum() *ResourceInstanceActionReason

func (ResourceInstanceActionReason) EnumDescriptor deprecated 

func (ResourceInstanceActionReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResourceInstanceActionReason.Descriptor instead.

func (ResourceInstanceActionReason) Number 

func (x ResourceInstanceActionReason) Number() protoreflect.EnumNumber

func (ResourceInstanceActionReason) String 

func (x ResourceInstanceActionReason) String() string

func (ResourceInstanceActionReason) Type 

func (ResourceInstanceActionReason) Type() protoreflect.EnumType

type ResourceInstanceChange 

type ResourceInstanceChange struct {

	// addr is a string representation of the resource instance address that
	// this change will apply to.
	Addr string `protobuf:"bytes,13,opt,name=addr,proto3" json:"addr,omitempty"`
	// prev_run_addr is a string representation of the address at which
	// this resource instance was tracked during the previous apply operation.
	//
	// This is populated only if it would be different from addr due to
	// Terraform having reacted to refactoring annotations in the configuration.
	// If empty, the previous run address is the same as the current address.
	PrevRunAddr string `protobuf:"bytes,14,opt,name=prev_run_addr,json=prevRunAddr,proto3" json:"prev_run_addr,omitempty"`
	// deposed_key, if set, indicates that this change applies to a deposed
	// object for the indicated instance with the given deposed key. If not
	// set, the change applies to the instance's current object.
	DeposedKey string `protobuf:"bytes,7,opt,name=deposed_key,json=deposedKey,proto3" json:"deposed_key,omitempty"`
	// provider is the address of the provider configuration that this change
	// was planned with, and thus the configuration that must be used to
	// apply it.
	Provider string `protobuf:"bytes,8,opt,name=provider,proto3" json:"provider,omitempty"`
	// Description of the proposed change. May use "create", "read", "update",
	// "replace", "delete" and "no-op" actions.
	Change *Change `protobuf:"bytes,9,opt,name=change,proto3" json:"change,omitempty"`
	// raw blob value provided by the provider as additional context for the
	// change. Must be considered an opaque value for any consumer other than
	// the provider that generated it, and will be returned verbatim to the
	// provider during the subsequent apply operation.
	Private []byte `protobuf:"bytes,10,opt,name=private,proto3" json:"private,omitempty"`
	// An unordered set of paths that prompted the change action to be
	// "replace" rather than "update". Empty for any action other than
	// "replace".
	RequiredReplace []*Path `protobuf:"bytes,11,rep,name=required_replace,json=requiredReplace,proto3" json:"required_replace,omitempty"`
	// Optional extra user-oriented context for why change.Action was chosen.
	// This is for user feedback only and never used to drive behavior during
	// apply.
	ActionReason ResourceInstanceActionReason `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ResourceInstanceChange) Descriptor deprecated 

func (*ResourceInstanceChange) Descriptor() ([]byte, []int)

Deprecated: Use ResourceInstanceChange.ProtoReflect.Descriptor instead.

func (*ResourceInstanceChange) GetActionReason 

func (x *ResourceInstanceChange) GetActionReason() ResourceInstanceActionReason

func (*ResourceInstanceChange) GetAddr added in v1.1.0 

func (x *ResourceInstanceChange) GetAddr() string

func (*ResourceInstanceChange) GetChange 

func (x *ResourceInstanceChange) GetChange() *Change

func (*ResourceInstanceChange) GetDeposedKey 

func (x *ResourceInstanceChange) GetDeposedKey() string

func (*ResourceInstanceChange) GetPrevRunAddr added in v1.1.0 

func (x *ResourceInstanceChange) GetPrevRunAddr() string

func (*ResourceInstanceChange) GetPrivate 

func (x *ResourceInstanceChange) GetPrivate() []byte

func (*ResourceInstanceChange) GetProvider 

func (x *ResourceInstanceChange) GetProvider() string

func (*ResourceInstanceChange) GetRequiredReplace 

func (x *ResourceInstanceChange) GetRequiredReplace() []*Path

func (*ResourceInstanceChange) ProtoMessage 

func (*ResourceInstanceChange) ProtoMessage()

func (*ResourceInstanceChange) ProtoReflect 

func (x *ResourceInstanceChange) ProtoReflect() protoreflect.Message

func (*ResourceInstanceChange) Reset 

func (x *ResourceInstanceChange) Reset()

func (*ResourceInstanceChange) String 

func (x *ResourceInstanceChange) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.