package tfplugin5

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetSchema (GetProviderSchema.Request, GetProviderSchema.Response)

  tfplugin5.proto:129

  ////// Information about what a provider supports/expects

  message GetProviderSchema.Request

  tfplugin5.proto:151

  (message has no fields)

  message GetProviderSchema.Response

  tfplugin5.proto:153

  • optional Schema provider = 1

  • map<string, Schema> resource_schemas = 2

  • map<string, Schema> data_source_schemas = 3

  • repeated Diagnostic diagnostics = 4

  • optional Schema provider_meta = 5

• rpc PrepareProviderConfig (PrepareProviderConfig.Request, PrepareProviderConfig.Response)

  tfplugin5.proto:130

  message PrepareProviderConfig.Request

  tfplugin5.proto:163

  • optional DynamicValue config = 1

  message PrepareProviderConfig.Response

  tfplugin5.proto:166

  • optional DynamicValue prepared_config = 1

  • repeated Diagnostic diagnostics = 2

• rpc ValidateResourceTypeConfig (ValidateResourceTypeConfig.Request, ValidateResourceTypeConfig.Response)

  tfplugin5.proto:131

  message ValidateResourceTypeConfig.Request

  tfplugin5.proto:200

  • string type_name = 1

  • optional DynamicValue config = 2

  message ValidateResourceTypeConfig.Response

  tfplugin5.proto:204

  • repeated Diagnostic diagnostics = 1

• rpc ValidateDataSourceConfig (ValidateDataSourceConfig.Request, ValidateDataSourceConfig.Response)

  tfplugin5.proto:132

  message ValidateDataSourceConfig.Request

  tfplugin5.proto:210

  • string type_name = 1

  • optional DynamicValue config = 2

  message ValidateDataSourceConfig.Response

  tfplugin5.proto:214

  • repeated Diagnostic diagnostics = 1

• rpc UpgradeResourceState (UpgradeResourceState.Request, UpgradeResourceState.Response)

  tfplugin5.proto:133

  message UpgradeResourceState.Request

  tfplugin5.proto:173

  • string type_name = 1

  • int64 version = 2

    version is the schema_version number recorded in the state file

  • optional RawState raw_state = 3

    raw_state is the raw states as stored for the resource. Core does not have access to the schema of prior_version, so it's the provider's responsibility to interpret this value using the appropriate older schema. The raw_state will be the json encoded state, or a legacy flat-mapped format.

  message UpgradeResourceState.Response

  tfplugin5.proto:186

  • optional DynamicValue upgraded_state = 1

    new_state is a msgpack-encoded data structure that, when interpreted with the _current_ schema for this resource type, is functionally equivalent to that which was given in prior_state_raw.

  • repeated Diagnostic diagnostics = 2

    diagnostics describes any errors encountered during migration that could not be safely resolved, and warnings about any possibly-risky assumptions made in the upgrade process.

• rpc Configure (Configure.Request, Configure.Response)

  tfplugin5.proto:136

  ////// One-time initialization, called before other functions below

  message Configure.Request

  tfplugin5.proto:220

  • string terraform_version = 1

  • optional DynamicValue config = 2

  message Configure.Response

  tfplugin5.proto:224

  • repeated Diagnostic diagnostics = 1

• rpc ReadResource (ReadResource.Request, ReadResource.Response)

  tfplugin5.proto:139

  ////// Managed Resource Lifecycle

  message ReadResource.Request

  tfplugin5.proto:230

  • string type_name = 1

  • optional DynamicValue current_state = 2

  • bytes private = 3

  • optional DynamicValue provider_meta = 4

  message ReadResource.Response

  tfplugin5.proto:236

  • optional DynamicValue new_state = 1

  • repeated Diagnostic diagnostics = 2

  • bytes private = 3

• rpc PlanResourceChange (PlanResourceChange.Request, PlanResourceChange.Response)

  tfplugin5.proto:140

  message PlanResourceChange.Request

  tfplugin5.proto:244

  • string type_name = 1

  • optional DynamicValue prior_state = 2

  • optional DynamicValue proposed_new_state = 3

  • optional DynamicValue config = 4

  • bytes prior_private = 5

  • optional DynamicValue provider_meta = 6

  message PlanResourceChange.Response

  tfplugin5.proto:253

  • optional DynamicValue planned_state = 1

  • repeated AttributePath requires_replace = 2

  • bytes planned_private = 3

  • repeated Diagnostic diagnostics = 4

  • bool legacy_type_system = 5

    This may be set only by the helper/schema "SDK" in the main Terraform repository, to request that Terraform Core >=0.12 permit additional inconsistencies that can result from the legacy SDK type system and its imprecise mapping to the >=0.12 type system. The change in behavior implied by this flag makes sense only for the specific details of the legacy SDK type system, and are not a general mechanism to avoid proper type handling in providers. ==== DO NOT USE THIS ==== ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== ==== DO NOT USE THIS ====

• rpc ApplyResourceChange (ApplyResourceChange.Request, ApplyResourceChange.Response)

  tfplugin5.proto:141

  message ApplyResourceChange.Request

  tfplugin5.proto:276

  • string type_name = 1

  • optional DynamicValue prior_state = 2

  • optional DynamicValue planned_state = 3

  • optional DynamicValue config = 4

  • bytes planned_private = 5

  • optional DynamicValue provider_meta = 6

  message ApplyResourceChange.Response

  tfplugin5.proto:284

  • optional DynamicValue new_state = 1

  • bytes private = 2

  • repeated Diagnostic diagnostics = 3

  • bool legacy_type_system = 4

    This may be set only by the helper/schema "SDK" in the main Terraform repository, to request that Terraform Core >=0.12 permit additional inconsistencies that can result from the legacy SDK type system and its imprecise mapping to the >=0.12 type system. The change in behavior implied by this flag makes sense only for the specific details of the legacy SDK type system, and are not a general mechanism to avoid proper type handling in providers. ==== DO NOT USE THIS ==== ==== THIS MUST BE LEFT UNSET IN ALL OTHER SDKS ==== ==== DO NOT USE THIS ====

• rpc ImportResourceState (ImportResourceState.Request, ImportResourceState.Response)

  tfplugin5.proto:142

  message ImportResourceState.Request

  tfplugin5.proto:305

  • string type_name = 1

  • string id = 2

  message ImportResourceState.Response

  tfplugin5.proto:316

  • repeated ImportedResource imported_resources = 1

  • repeated Diagnostic diagnostics = 2

• rpc ReadDataSource (ReadDataSource.Request, ReadDataSource.Response)

  tfplugin5.proto:144

  message ReadDataSource.Request

  tfplugin5.proto:323

  • string type_name = 1

  • optional DynamicValue config = 2

  • optional DynamicValue provider_meta = 3

  message ReadDataSource.Response

  tfplugin5.proto:328

  • optional DynamicValue state = 1

  • repeated Diagnostic diagnostics = 2

• rpc Stop (Stop.Request, Stop.Response)

  tfplugin5.proto:147

  ////// Graceful Shutdown

• rpc GetSchema (GetProvisionerSchema.Request, GetProvisionerSchema.Response)

  tfplugin5.proto:335

  message GetProvisionerSchema.Request

  tfplugin5.proto:342

  (message has no fields)

  message GetProvisionerSchema.Response

  tfplugin5.proto:344

  • optional Schema provisioner = 1

  • repeated Diagnostic diagnostics = 2

• rpc ValidateProvisionerConfig (ValidateProvisionerConfig.Request, ValidateProvisionerConfig.Response)

  tfplugin5.proto:336

  message ValidateProvisionerConfig.Request

  tfplugin5.proto:351

  • optional DynamicValue config = 1

  message ValidateProvisionerConfig.Response

  tfplugin5.proto:354

  • repeated Diagnostic diagnostics = 1

• rpc ProvisionResource (ProvisionResource.Request, stream ProvisionResource.Response)

  tfplugin5.proto:337

  message ProvisionResource.Request

  tfplugin5.proto:360

  • optional DynamicValue config = 1

  • optional DynamicValue connection = 2

  message ProvisionResource.Response

  tfplugin5.proto:364

  • string output = 1

  • repeated Diagnostic diagnostics = 2

• rpc Stop (Stop.Request, Stop.Response)

  tfplugin5.proto:338

(message has no fields)

Used in: Diagnostic, PlanResourceChange.Response

• repeated AttributePath.Step steps = 1

Used in: AttributePath

• oneof selector

  • string attribute_name = 1

    Set "attribute_name" to represent looking up an attribute in the current object value.

  • string element_key_string = 2

    Set "element_key_*" to represent looking up an element in an indexable collection type.

  • int64 element_key_int = 3

(message has no fields)

Used in: ApplyResourceChange.Response, Configure.Response, GetProviderSchema.Response, GetProvisionerSchema.Response, ImportResourceState.Response, PlanResourceChange.Response, PrepareProviderConfig.Response, ProvisionResource.Response, ReadDataSource.Response, ReadResource.Response, UpgradeResourceState.Response, ValidateDataSourceConfig.Response, ValidateProvisionerConfig.Response, ValidateResourceTypeConfig.Response

• Diagnostic.Severity severity = 1

• string summary = 2

• string detail = 3

• optional AttributePath attribute = 4

Used in: Diagnostic

• INVALID = 0

• ERROR = 1

• WARNING = 2

DynamicValue is an opaque encoding of terraform data, with the field name indicating the encoding scheme used.

Used in: ApplyResourceChange.Request, ApplyResourceChange.Response, Configure.Request, ImportResourceState.ImportedResource, PlanResourceChange.Request, PlanResourceChange.Response, PrepareProviderConfig.Request, PrepareProviderConfig.Response, ProvisionResource.Request, ReadDataSource.Request, ReadDataSource.Response, ReadResource.Request, ReadResource.Response, UpgradeResourceState.Response, ValidateDataSourceConfig.Request, ValidateProvisionerConfig.Request, ValidateResourceTypeConfig.Request

• bytes msgpack = 1

• bytes json = 2

(message has no fields)

(message has no fields)

(message has no fields)

Used in: Response

• string type_name = 1

• optional DynamicValue state = 2

• bytes private = 3

(message has no fields)

(message has no fields)

(message has no fields)

RawState holds the stored state for a resource to be upgraded by the provider. It can be in one of two formats, the current json encoded format in bytes, or the legacy flatmap format as a map of strings.

Used in: UpgradeResourceState.Request

• bytes json = 1

• map<string, string> flatmap = 2

(message has no fields)

(message has no fields)

Schema is the configuration schema for a Resource, Provider, or Provisioner.

Used in: GetProviderSchema.Response, GetProvisionerSchema.Response

• int64 version = 1

  The version of the schema. Schemas are versioned, so that providers can upgrade a saved resource state when the schema is changed.

• optional Schema.Block block = 2

  Block is the top level configuration block for this schema.

Used in: Block

• string name = 1

• bytes type = 2

• string description = 3

• bool required = 4

• bool optional = 5

• bool computed = 6

• bool sensitive = 7

• StringKind description_kind = 8

• bool deprecated = 9

Used in: Schema, NestedBlock

• int64 version = 1

• repeated Attribute attributes = 2

• repeated NestedBlock block_types = 3

• string description = 4

• StringKind description_kind = 5

• bool deprecated = 6

Used in: Block

• string type_name = 1

• optional Block block = 2

• NestedBlock.NestingMode nesting = 3

• int64 min_items = 4

• int64 max_items = 5

Used in: NestedBlock

• INVALID = 0

• SINGLE = 1

• LIST = 2

• SET = 3

• MAP = 4

• GROUP = 5

(message has no fields)

Used as request type in: Provider.Stop, Provisioner.Stop

(message has no fields)

Used as response type in: Provider.Stop, Provisioner.Stop

• string Error = 1

Used in: Schema.Attribute, Schema.Block

• PLAIN = 0

• MARKDOWN = 1

(message has no fields)

(message has no fields)

(message has no fields)

(message has no fields)