root
API
Generated with
root/pulumirpc/pulumirpc.resource

pulumirpc.resource

package pulumirpc.resource

Members list

Type members

Classlikes

final case class Parameterization(name: String, version: String, value: ByteString, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[Parameterization]

Value parameters

name

the parameterized package name.

value

the parameter value for the parameterized package.

version

the parameterized package version.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[Parameterization]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ReadResourceRequest(id: String, `type`: String, name: String, parent: String, properties: Option[Struct], dependencies: Seq[String], provider: String, version: String, acceptSecrets: Boolean, additionalSecretOutputs: Seq[String], acceptResources: Boolean, pluginDownloadURL: String, pluginChecksums: Map[String, ByteString], sourcePosition: Option[SourcePosition], packageRef: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ReadResourceRequest]

ReadResourceRequest contains enough information to uniquely qualify and read a resource's state.

ReadResourceRequest contains enough information to uniquely qualify and read a resource's state.

Value parameters

acceptResources

when true operations should return resource references as strongly typed.

acceptSecrets

when true operations should return secrets as strongly typed.

additionalSecretOutputs

a list of output properties that should also be treated as secret, in addition to ones we detect.

dependencies

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

id

the ID of the resource to read.

name

the name, for URN purposes, of the object.

packageRef

a reference from RegisterProviderRequest.

parent

an optional parent URN that this child resource belongs to.

pluginChecksums

a map of checksums of the provider to use when servicing this request.

pluginDownloadURL

the server url of the provider to use when servicing this request.

properties

optional state sufficient to uniquely identify the resource.

provider

an optional reference to the provider to use for this read.

sourcePosition

the optional source position of the user code that initiated the read.

type

the type of the resource object.

version

the version of the provider to use when servicing this request.

Attributes

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

Attributes

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

ReadResourceResponse contains the result of reading a resource's state.

ReadResourceResponse contains the result of reading a resource's state.

Value parameters

properties

the state of the resource read from the live environment.

urn

the URN for this resource.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ReadResourceResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RegisterPackageRequest(name: String, version: String, downloadUrl: String, checksums: Map[String, ByteString], parameterization: Option[Parameterization], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RegisterPackageRequest]

Value parameters

checksums

the optional plugin checksums.

downloadUrl

the optional plugin download url.

name

the plugin name.

parameterization

the optional parameterization for this package.

version

the plugin version.

Attributes

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

Attributes

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

Value parameters

ref

The UUID package reference for this registered package.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RegisterPackageResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RegisterResourceOutputsRequest(urn: String, outputs: Option[Struct], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RegisterResourceOutputsRequest]

RegisterResourceOutputsRequest adds extra resource outputs created by the program after registration has occurred.

RegisterResourceOutputsRequest adds extra resource outputs created by the program after registration has occurred.

Value parameters

outputs

additional output properties to add to the existing resource.

urn

the URN for the resource to attach output properties to.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RegisterResourceOutputsRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RegisterResourceRequest(`type`: String, name: String, parent: String, custom: Boolean, `object`: Option[Struct], protect: Boolean, dependencies: Seq[String], provider: String, propertyDependencies: Map[String, PropertyDependencies], deleteBeforeReplace: Boolean, version: String, ignoreChanges: Seq[String], acceptSecrets: Boolean, additionalSecretOutputs: Seq[String], aliasURNs: Seq[String], importId: String, customTimeouts: Option[CustomTimeouts], deleteBeforeReplaceDefined: Boolean, supportsPartialValues: Boolean, remote: Boolean, acceptResources: Boolean, providers: Map[String, String], replaceOnChanges: Seq[String], pluginDownloadURL: String, pluginChecksums: Map[String, ByteString], retainOnDelete: Boolean, aliases: Seq[Alias], deletedWith: String, aliasSpecs: Boolean, sourcePosition: Option[SourcePosition], transforms: Seq[Callback], supportsResultReporting: Boolean, packageRef: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RegisterResourceRequest]

RegisterResourceRequest contains information about a resource object that was newly allocated.

RegisterResourceRequest contains information about a resource object that was newly allocated.

Value parameters

acceptResources

when true operations should return resource references as strongly typed.

acceptSecrets

when true operations should return secrets as strongly typed.

additionalSecretOutputs

a list of output properties that should also be treated as secret, in addition to ones we detect.

aliasSpecs

Indicates that alias specs are specified correctly according to the spec. Older versions of the Node.js SDK did not send alias specs correctly. If this is not set to true and the engine detects the request is from the Node.js runtime, the engine will transform incorrect alias specs into correct ones. Other SDKs that are correctly specifying alias specs could set this to true, but it's not necessary.

aliasURNs

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

aliases

a list of additional aliases that should be considered the same.

custom

true if the resource is a custom, managed by a plugin's CRUD operations.

customTimeouts

ability to pass a custom Timeout block.

deleteBeforeReplace

true if this resource should be deleted before replacement.

deleteBeforeReplaceDefined

true if the deleteBeforeReplace property should be treated as defined even if it is false.

deletedWith

if set the engine will not call the resource providers delete method for this resource when specified resource is deleted.

dependencies

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

ignoreChanges

a list of property selectors to ignore during updates.

importId

if set, this resource's state should be imported from the given ID.

name

the name, for URN purposes, of the object.

object

an object produced by the interpreter/source.

packageRef

a reference from RegisterProviderRequest.

parent

an optional parent URN that this child resource belongs to.

pluginChecksums

a map of checksums expected for the provider plugin.

pluginDownloadURL

the server URL of the provider to use when servicing this request.

propertyDependencies

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

protect

true if the resource should be marked protected.

provider

an optional reference to the provider to manage this resource's CRUD operations.

providers

an optional reference to the provider map to manage this resource's CRUD operations.

remote

true if the resource is a plugin-managed component resource.

replaceOnChanges

a list of properties that if changed should force a replacement.

retainOnDelete

if true the engine will not call the resource providers delete method for this resource.

sourcePosition

the optional source position of the user code that initiated the register.

supportsPartialValues

true if the request is from an SDK that supports partially-known properties during preview.

supportsResultReporting

true if the request is from an SDK that supports the result field in the response.

transforms

a list of transforms to apply to the resource before registering it.

type

the type of the object allocated.

version

the version of the provider to use when servicing this request.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RegisterResourceRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class RegisterResourceResponse(urn: String, id: String, `object`: Option[Struct], stable: Boolean, stables: Seq[String], propertyDependencies: Map[String, PropertyDependencies], result: Result, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[RegisterResourceResponse]

RegisterResourceResponse is returned by the engine after a resource has finished being initialized. It includes the auto-assigned URN, the provider-assigned ID, and any other properties initialized by the engine.

RegisterResourceResponse is returned by the engine after a resource has finished being initialized. It includes the auto-assigned URN, the provider-assigned ID, and any other properties initialized by the engine.

Value parameters

id

the unique ID assigned by the provider.

object

the resulting object properties, including provider defaults.

propertyDependencies

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

result

the reason, whether the resource registration was successful, failed, or skipped.

stable

if true, the object's state is stable and may be trusted not to change.

stables

an optional list of guaranteed-stable properties.

urn

the URN assigned by the engine.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[RegisterResourceResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ResourceCallRequest(tok: String, args: Option[Struct], argDependencies: Map[String, ArgumentDependencies], provider: String, version: String, pluginDownloadURL: String, pluginChecksums: Map[String, ByteString], sourcePosition: Option[SourcePosition], packageRef: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ResourceCallRequest]

Value parameters

argDependencies

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

args

the arguments for the function invocation.

packageRef

a reference from RegisterProviderRequest.

pluginChecksums

a map of checksums of the provider to use when servicing this request.

pluginDownloadURL

the pluginDownloadURL of the provider to use when servicing this request.

provider

an optional reference to the provider to use for this invoke.

sourcePosition

the optional source position of the user code that initiated the call.

tok

the function token to invoke.

version

the version of the provider to use when servicing this request.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[ResourceCallRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class ResourceInvokeRequest(tok: String, args: Option[Struct], provider: String, version: String, acceptResources: Boolean, pluginDownloadURL: String, pluginChecksums: Map[String, ByteString], sourcePosition: Option[SourcePosition], packageRef: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[ResourceInvokeRequest]

Value parameters

acceptResources

when true operations should return resource references as strongly typed.

args

the arguments for the function invocation.

packageRef

a reference from RegisterProviderRequest.

pluginChecksums

a map of checksums expected for the provider plugin.

pluginDownloadURL

an optional reference to the provider url to use for this invoke.

provider

an optional reference to the provider version to use for this invoke.

sourcePosition

the optional source position of the user code that initiated the invoke.

tok

the function token to invoke.

version

the version of the provider to use when servicing this request.

Attributes

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

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object ResourceProto extends GeneratedFileObject

Attributes

Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
sealed abstract class Result(val value: Int) extends GeneratedEnum

Attributes

Companion
object
Supertypes
trait GeneratedEnum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
object FAIL
trait Recognized
object SKIP
object SUCCESS
class Unrecognized
object Result extends GeneratedEnumCompanion[Result]

Attributes

Companion
class
Supertypes
trait Sum
trait Mirror
trait GeneratedEnumCompanion[Result]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Result.type
final case class SupportsFeatureRequest(id: String, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SupportsFeatureRequest]

SupportsFeatureRequest allows a client to test if the resource monitor supports a certain feature, which it may use to control the format or types of messages it sends.

SupportsFeatureRequest allows a client to test if the resource monitor supports a certain feature, which it may use to control the format or types of messages it sends.

Value parameters

id

the ID of the feature to test support for.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SupportsFeatureRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class SupportsFeatureResponse(hasSupport: Boolean, unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[SupportsFeatureResponse]

Value parameters

hasSupport

true when the resource monitor supports this feature.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[SupportsFeatureResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TransformInvokeOptions(provider: String, pluginDownloadUrl: String, version: String, pluginChecksums: Map[String, ByteString], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransformInvokeOptions]

TransformInvokeOptions is a subset of all invoke options that are relevant to transforms.

TransformInvokeOptions is a subset of all invoke options that are relevant to transforms.

Attributes

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

Attributes

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

TransformInvokeRequest is the request object for the TransformInvoke RPC.

TransformInvokeRequest is the request object for the TransformInvoke RPC.

Value parameters

args

the input args of the resource.

options

the options for the resource.

token

the token for the invoke request.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransformInvokeRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TransformInvokeResponse(args: Option[Struct], options: Option[TransformInvokeOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransformInvokeResponse]

TransformInvokeResponse is the response object for the TransformInvoke RPC.

TransformInvokeResponse is the response object for the TransformInvoke RPC.

Value parameters

args

the transformed input args.

options

the options for the resource.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransformInvokeResponse]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TransformRequest(`type`: String, name: String, custom: Boolean, parent: String, properties: Option[Struct], options: Option[TransformResourceOptions], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransformRequest]

Value parameters

custom

true if the resource is a custom resource, else it's a component resource.

name

the name of the resource.

options

the options for the resource.

parent

the parent of the resource, this can't be changed by the transform.

properties

the input properties of the resource.

type

the type of the resource.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[TransformRequest]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
final case class TransformResourceOptions(dependsOn: Seq[String], protect: Boolean, ignoreChanges: Seq[String], replaceOnChanges: Seq[String], version: String, aliases: Seq[Alias], provider: String, customTimeouts: Option[CustomTimeouts], pluginDownloadUrl: String, retainOnDelete: Boolean, deletedWith: String, deleteBeforeReplace: Option[Boolean], additionalSecretOutputs: Seq[String], providers: Map[String, String], pluginChecksums: Map[String, ByteString], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransformResourceOptions]

TransformResourceOptions is a subset of all resource options that are relevant to transforms.

TransformResourceOptions is a subset of all resource options that are relevant to transforms.

Attributes

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

Attributes

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

Value parameters

options

the options for the resource.

properties

the transformed input properties.

Attributes

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

Attributes

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