root
API
Generated with
root/pulumirpc/pulumirpc.provider

pulumirpc.provider

package pulumirpc.provider

Members list

Type members

Classlikes

final case class CallRequest(tok: String, args: Option[Struct], argDependencies: Map[String, ArgumentDependencies], project: String, stack: String, config: Map[String, String], configSecretKeys: Seq[String], dryRun: Boolean, parallel: Int, monitorEndpoint: String, organization: String, acceptsOutputValues: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CallRequest]

Value parameters

acceptsOutputValues

the engine can be passed output values back, returnDependencies can be left blank if returning output values.

argDependencies

a map from argument keys to the dependencies of the argument.

args

the arguments for the function invocation.

config

the configuration variables to apply before running.

configSecretKeys

the configuration keys that have secret values.

dryRun

true if we're only doing a dryrun (preview).

monitorEndpoint

the address for communicating back to the resource monitor.

organization

the organization of the stack being deployed into.

parallel

the degree of parallelism for resource operations (<=1 for serial).

project

the project name.

stack

the name of the stack being deployed into.

tok

the function token to invoke.

Attributes

Companion
object
Supertypes
trait Updatable[CallRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CallRequest extends GeneratedMessageCompanion[CallRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CallRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CallResponse(`return`: Option[Struct], failures: Seq[CheckFailure], returnDependencies: Map[String, ReturnDependencies], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CallResponse]

Value parameters

failures

the failures if any arguments didn't pass verification.

return

the returned values, if call was successful.

returnDependencies

a map from return value keys to the dependencies of the return value. returnDependencies will be augmented by the set of dependencies specified in return via output property values.

Attributes

Companion
object
Supertypes
trait Updatable[CallResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CallResponse extends GeneratedMessageCompanion[CallResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CallResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CheckFailure(property: String, reason: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CheckFailure]

Value parameters

property

the property that failed validation.

reason

the reason that the property failed validation.

Attributes

Companion
object
Supertypes
trait Updatable[CheckFailure]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CheckFailure extends GeneratedMessageCompanion[CheckFailure]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CheckFailure]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CheckRequest(urn: String, olds: Option[Struct], news: Option[Struct], randomSeed: ByteString, name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CheckRequest]

Value parameters

name

the Pulumi name for this resource.

news

the new Pulumi inputs for this resource. Note that if the user specifies the ignoreChanges resource option, the value of news passed to the provider here may differ from the values written in the program source. It will be pre-processed by replacing every ignoreChanges property by a matching value from the old inputs stored in the state. See also: https://www.pulumi.com/docs/concepts/options/ignorechanges/

olds

the old Pulumi inputs for this resource, if any.

randomSeed

a deterministically random hash, primarily intended for global unique naming.

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[CheckRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CheckRequest extends GeneratedMessageCompanion[CheckRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CheckRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CheckResponse(inputs: Option[Struct], failures: Seq[CheckFailure], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CheckResponse]

Value parameters

failures

any validation failures that occurred.

inputs

the provider inputs for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[CheckResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CheckResponse extends GeneratedMessageCompanion[CheckResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CheckResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ConfigureErrorMissingKeys(missingKeys: Seq[MissingKey], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConfigureErrorMissingKeys]

ConfigureErrorMissingKeys is sent as a Detail on an error returned from ResourceProvider.Configure.

ConfigureErrorMissingKeys is sent as a Detail on an error returned from ResourceProvider.Configure.

Value parameters

missingKeys

a list of required configuration keys that were not supplied.

Attributes

Companion
object
Supertypes
trait Updatable[ConfigureErrorMissingKeys]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigureErrorMissingKeys extends GeneratedMessageCompanion[ConfigureErrorMissingKeys]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConfigureErrorMissingKeys]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ConfigureRequest(variables: Map[String, String], args: Option[Struct], acceptSecrets: Boolean, acceptResources: Boolean, sendsOldInputs: Boolean, sendsOldInputsToDelete: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConfigureRequest]

Value parameters

acceptResources

when true, operations should return resources as strongly typed values to the provider.

acceptSecrets

when true, operations should return secrets as strongly typed.

args

the input properties for the provider. Only filled in for newer providers.

sendsOldInputs

when true, diff and update will be called with the old outputs and the old inputs.

sendsOldInputsToDelete

when true, delete will be called with the old outputs and the old inputs.

variables

a map of configuration keys to values.

Attributes

Companion
object
Supertypes
trait Updatable[ConfigureRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigureRequest extends GeneratedMessageCompanion[ConfigureRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConfigureRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ConfigureResponse(acceptSecrets: Boolean, supportsPreview: Boolean, acceptResources: Boolean, acceptOutputs: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConfigureResponse]

Value parameters

acceptOutputs

when true, the engine should pass output values to the provider.

acceptResources

when true, the engine should pass resources as strongly typed values to the provider.

acceptSecrets

when true, the engine should pass secrets as strongly typed values to the provider.

supportsPreview

when true, the engine should invoke create and update with preview=true during previews.

Attributes

Companion
object
Supertypes
trait Updatable[ConfigureResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConfigureResponse extends GeneratedMessageCompanion[ConfigureResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConfigureResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ConstructRequest(project: String, stack: String, config: Map[String, String], dryRun: Boolean, parallel: Int, monitorEndpoint: String, `type`: String, name: String, parent: String, inputs: Option[Struct], inputDependencies: Map[String, PropertyDependencies], providers: Map[String, String], dependencies: Seq[String], configSecretKeys: Seq[String], organization: String, protect: Boolean, aliases: Seq[String], additionalSecretOutputs: Seq[String], customTimeouts: Option[CustomTimeouts], deletedWith: String, deleteBeforeReplace: Boolean, ignoreChanges: Seq[String], replaceOnChanges: Seq[String], retainOnDelete: Boolean, acceptsOutputValues: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConstructRequest]

Value parameters

acceptsOutputValues

the engine can be passed output values back, stateDependencies can be left blank if returning output values.

additionalSecretOutputs

additional output properties that should be treated as secrets.

aliases

a list of additional URNs that shoud be considered the same.

config

the configuration variables to apply before running.

configSecretKeys

the configuration keys that have secret values.

customTimeouts

default timeouts for CRUD operations on this resource.

deleteBeforeReplace

whether to delete the resource before replacing it.

deletedWith

URN of a resource that, if deleted, also deletes this resource.

dependencies

a list of URNs that this resource depends on, as observed by the language host.

dryRun

true if we're only doing a dryrun (preview).

ignoreChanges

properties that should be ignored during a diff

inputDependencies

a map from property keys to the dependencies of the property.

inputs

the inputs to the resource constructor.

monitorEndpoint

the address for communicating back to the resource monitor.

name

the name, for URN purposes, of the object.

organization

the organization of the stack being deployed into.

parallel

the degree of parallelism for resource operations (<=1 for serial).

parent

an optional parent URN that this child resource belongs to.

project

the project name.

protect

Resource options: Do not change field IDs. Add new fields at the end. true if the resource should be marked protected.

providers

the map of providers to use for this resource's children.

replaceOnChanges

properties that, when changed, trigger a replacement

retainOnDelete

whether to retain the resource in the cloud provider when it is deleted

stack

the name of the stack being deployed into.

type

the type of the object allocated.

Attributes

Companion
object
Supertypes
trait Updatable[ConstructRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConstructRequest extends GeneratedMessageCompanion[ConstructRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConstructRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ConstructResponse(urn: String, state: Option[Struct], stateDependencies: Map[String, PropertyDependencies], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ConstructResponse]

Value parameters

state

any properties that were computed during construction.

stateDependencies

a map from property keys to the dependencies of the property.

urn

the URN of the component resource.

Attributes

Companion
object
Supertypes
trait Updatable[ConstructResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ConstructResponse extends GeneratedMessageCompanion[ConstructResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ConstructResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateRequest(urn: String, properties: Option[Struct], timeout: Double, preview: Boolean, name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateRequest]

Value parameters

name

the Pulumi name for this resource.

preview

true if this is a preview and the provider should not actually create the resource.

properties

the provider inputs to set during creation.

timeout

the create request timeout represented in seconds.

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[CreateRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateRequest extends GeneratedMessageCompanion[CreateRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class CreateResponse(id: String, properties: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[CreateResponse]

NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed.

NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed.

Value parameters

id

the ID of the created resource.

properties

any properties that were computed during creation.

Attributes

Companion
object
Supertypes
trait Updatable[CreateResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object CreateResponse extends GeneratedMessageCompanion[CreateResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[CreateResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DeleteRequest(id: String, urn: String, properties: Option[Struct], timeout: Double, oldInputs: Option[Struct], name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DeleteRequest]

Value parameters

id

the ID of the resource to delete.

name

the Pulumi name for this resource.

oldInputs

the old input values of the resource to delete.

properties

the current properties on the resource.

timeout

the delete request timeout represented in seconds.

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[DeleteRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DeleteRequest extends GeneratedMessageCompanion[DeleteRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DeleteRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DiffRequest(id: String, urn: String, olds: Option[Struct], news: Option[Struct], ignoreChanges: Seq[String], oldInputs: Option[Struct], name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DiffRequest]

Value parameters

id

the ID of the resource to diff.

ignoreChanges

a set of property paths that should be treated as unchanged.

name

the Pulumi name for this resource.

news

the new input values of resource to diff, copied from CheckResponse.inputs.

oldInputs

the old input values of the resource to diff.

olds

the old output values of resource to diff.

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[DiffRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DiffRequest extends GeneratedMessageCompanion[DiffRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DiffRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class DiffResponse(replaces: Seq[String], stables: Seq[String], deleteBeforeReplace: Boolean, changes: DiffChanges, diffs: Seq[String], detailedDiff: Map[String, PropertyDiff], hasDetailedDiff: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[DiffResponse]

Value parameters

changes

if true, this diff represents an actual difference and thus requires an update.

deleteBeforeReplace

if true, this resource must be deleted before replacing it.

detailedDiff

detailedDiff is an optional field that contains map from each changed property to the type of the change. The keys of this map are property paths. These paths are essentially Javascript property access expressions in which all elements are literals, and obey the following EBNF-ish grammar: propertyName := [a-zA-Z_$] { [a-zA-Z0-9_$] } quotedPropertyName := '"' ( '&92;' '"' | [^"] ) { ( '&92;' '"' | [^"] ) } '"' arrayIndex := { [0-9] } propertyIndex := '[' ( quotedPropertyName | arrayIndex ) ']' rootProperty := ( propertyName | propertyIndex ) propertyAccessor := ( ( '.' propertyName ) | propertyIndex ) path := rootProperty { propertyAccessor } Examples of valid keys:

  • root
  • root.nested
  • root["nested"]
  • root.double.nest
  • root["double"].nest
  • root["double"]["nest"]
  • root.array[0]
  • root.array[100]
  • root.array[0].nested
  • root.array[0][1].nested
  • root.nested.array[0].double[1]
  • root["key with &92;"escaped&92;" quotes"]
  • root["key with a ."]
  • ["root key with &92;"escaped&92;" quotes"].nested
  • ["root key with a ."][100] a detailed diff appropriate for display.
diffs

a list of the properties that changed. This should only contain top level property names, it does not support nested properties. For that use detailedDiff.

hasDetailedDiff

true if this response contains a detailed diff.

replaces

if this update requires a replacement, the set of properties triggering it.

stables

an optional list of properties that will not ever change.

Attributes

Companion
object
Supertypes
trait Updatable[DiffResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DiffResponse extends GeneratedMessageCompanion[DiffResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[DiffResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ErrorResourceInitFailed(id: String, properties: Option[Struct], reasons: Seq[String], inputs: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ErrorResourceInitFailed]

ErrorResourceInitFailed is sent as a Detail ResourceProvider.{Create, Update} fail because a resource was created successfully, but failed to initialize.

ErrorResourceInitFailed is sent as a Detail ResourceProvider.{Create, Update} fail because a resource was created successfully, but failed to initialize.

Value parameters

id

the ID of the created resource.

inputs

the current inputs to this resource (only applicable for Read)

properties

any properties that were computed during updating.

reasons

error messages associated with initialization failure.

Attributes

Companion
object
Supertypes
trait Updatable[ErrorResourceInitFailed]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ErrorResourceInitFailed extends GeneratedMessageCompanion[ErrorResourceInitFailed]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ErrorResourceInitFailed]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetMappingRequest(key: String, provider: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetMappingRequest]

GetMappingRequest allows providers to return ecosystem specific information to allow the provider to be converted from a source markup to Pulumi. It's expected that provider bridges that target a given ecosystem (e.g. Terraform, Kubernetes) would also publish a conversion plugin to convert markup from that ecosystem to Pulumi, using the bridged providers.

GetMappingRequest allows providers to return ecosystem specific information to allow the provider to be converted from a source markup to Pulumi. It's expected that provider bridges that target a given ecosystem (e.g. Terraform, Kubernetes) would also publish a conversion plugin to convert markup from that ecosystem to Pulumi, using the bridged providers.

Value parameters

key

the conversion key for the mapping being requested.

provider

the optional provider key for the mapping being requested, if this is empty the provider should assume this request is from an old engine from before GetMappings and should return it's "primary" mapping. If this is set then the provider field in GetMappingResponse should be the same.

Attributes

Companion
object
Supertypes
trait Updatable[GetMappingRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetMappingRequest extends GeneratedMessageCompanion[GetMappingRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetMappingRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetMappingResponse(provider: String, data: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetMappingResponse]

GetMappingResponse returns convert plugin specific data for this provider. This will normally be human readable JSON, but the engine doesn't mandate any form.

GetMappingResponse returns convert plugin specific data for this provider. This will normally be human readable JSON, but the engine doesn't mandate any form.

Value parameters

data

the conversion plugin specific data.

provider

the provider key this is mapping for. For example the Pulumi provider "terraform-template" would return "template" for this.

Attributes

Companion
object
Supertypes
trait Updatable[GetMappingResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetMappingResponse extends GeneratedMessageCompanion[GetMappingResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetMappingResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetMappingsRequest(key: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetMappingsRequest]

GetMappingsRequest allows providers to return ecosystem specific information without having to send back large data blobs for provider mappings that the engine doesn't then need.

GetMappingsRequest allows providers to return ecosystem specific information without having to send back large data blobs for provider mappings that the engine doesn't then need.

Value parameters

key

the conversion key for the mapping being requested.

Attributes

Companion
object
Supertypes
trait Updatable[GetMappingsRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetMappingsRequest extends GeneratedMessageCompanion[GetMappingsRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetMappingsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetMappingsResponse(providers: Seq[String], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetMappingsResponse]

GetMappingsRequest returns a list of providers that this provider can provide mapping information for.

GetMappingsRequest returns a list of providers that this provider can provide mapping information for.

Value parameters

providers

the provider keys this provider can supply mappings for. For example the Pulumi provider "terraform-template" would return ["template"] for this.

Attributes

Companion
object
Supertypes
trait Updatable[GetMappingsResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetMappingsResponse extends GeneratedMessageCompanion[GetMappingsResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetMappingsResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetSchemaRequest(version: Int, subpackageName: String, subpackageVersion: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetSchemaRequest]

Value parameters

subpackageName

the name of the sub-package to lookup

subpackageVersion

the version of the sub-package to lookup

version

the schema version.

Attributes

Companion
object
Supertypes
trait Updatable[GetSchemaRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetSchemaRequest extends GeneratedMessageCompanion[GetSchemaRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetSchemaRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class GetSchemaResponse(schema: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[GetSchemaResponse]

Value parameters

schema

the JSON-encoded schema.

Attributes

Companion
object
Supertypes
trait Updatable[GetSchemaResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object GetSchemaResponse extends GeneratedMessageCompanion[GetSchemaResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[GetSchemaResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class InvokeRequest(tok: String, args: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[InvokeRequest]

Value parameters

args

the arguments for the function invocation.

tok

the function token to invoke.

Attributes

Companion
object
Supertypes
trait Updatable[InvokeRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InvokeRequest extends GeneratedMessageCompanion[InvokeRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[InvokeRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class InvokeResponse(`return`: Option[Struct], failures: Seq[CheckFailure], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[InvokeResponse]

Value parameters

failures

the failures if any arguments didn't pass verification.

return

the returned values, if invoke was successful.

Attributes

Companion
object
Supertypes
trait Updatable[InvokeResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object InvokeResponse extends GeneratedMessageCompanion[InvokeResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[InvokeResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ParameterizeRequest(parameters: Parameters, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ParameterizeRequest]

Attributes

Companion
object
Supertypes
trait Updatable[ParameterizeRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParameterizeRequest extends GeneratedMessageCompanion[ParameterizeRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ParameterizeRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ParameterizeResponse(name: String, version: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ParameterizeResponse]

Value parameters

name

The name of the sub-package parameterized.

version

The version of the sub-package parameterized.

Attributes

Companion
object
Supertypes
trait Updatable[ParameterizeResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ParameterizeResponse extends GeneratedMessageCompanion[ParameterizeResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ParameterizeResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class PropertyDiff(kind: Kind, inputDiff: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[PropertyDiff]

Value parameters

inputDiff

The difference is between old and new inputs, not old and new state.

kind

The kind of diff asdsociated with this property.

Attributes

Companion
object
Supertypes
trait Updatable[PropertyDiff]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object PropertyDiff extends GeneratedMessageCompanion[PropertyDiff]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[PropertyDiff]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ProviderProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
final case class ReadRequest(id: String, urn: String, properties: Option[Struct], inputs: Option[Struct], name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ReadRequest]

Value parameters

id

the ID of the resource to read.

inputs

the current inputs, if any (only populated during refresh).

name

the Pulumi name for this resource.

properties

the current state (sufficiently complete to identify the resource).

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[ReadRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReadRequest extends GeneratedMessageCompanion[ReadRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ReadResponse(id: String, properties: Option[Struct], inputs: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ReadResponse]

Value parameters

id

the ID of the resource read back (or empty if missing).

inputs

the inputs for this resource that would be returned from Check.

properties

the state of the resource read from the live environment.

Attributes

Companion
object
Supertypes
trait Updatable[ReadResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ReadResponse extends GeneratedMessageCompanion[ReadResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
object ResourceProviderGrpc

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
final case class UpdateRequest(id: String, urn: String, olds: Option[Struct], news: Option[Struct], timeout: Double, ignoreChanges: Seq[String], preview: Boolean, oldInputs: Option[Struct], name: String, `type`: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateRequest]

NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed.

NOTE: The partial-update-error equivalent of this message is ErrorResourceInitFailed.

Value parameters

id

the ID of the resource to update.

ignoreChanges

a set of property paths that should be treated as unchanged.

name

the Pulumi name for this resource.

news

the new values of provider inputs for the resource to update, copied from CheckResponse.inputs.

oldInputs

the old input values of the resource to diff.

olds

the old values of provider inputs for the resource to update.

preview

true if this is a preview and the provider should not actually create the resource.

timeout

the update request timeout represented in seconds.

type

the Pulumi type for this resource.

urn

the Pulumi URN for this resource.

Attributes

Companion
object
Supertypes
trait Updatable[UpdateRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateRequest extends GeneratedMessageCompanion[UpdateRequest]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class UpdateResponse(properties: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[UpdateResponse]

Value parameters

properties

any properties that were computed during updating.

Attributes

Companion
object
Supertypes
trait Updatable[UpdateResponse]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object UpdateResponse extends GeneratedMessageCompanion[UpdateResponse]

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[UpdateResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Generated with