RegisterResourceRequest

pulumirpc.resource.RegisterResourceRequest
See theRegisterResourceRequest companion object
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.

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
Graph
Supertypes
trait Updatable[RegisterResourceRequest]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addPluginChecksums(`__vs`: (String, ByteString)*): RegisterResourceRequest
def getField(`__field`: FieldDescriptor): PValue
def getFieldByNumber(`__fieldNumber`: Int): Any
def getObject: Struct
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

def withObject(`__v`: Struct): RegisterResourceRequest
def withUnknownFields(`__v`: UnknownFieldSet): RegisterResourceRequest
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage

Attributes

Inherited from:
Updatable
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage