pulumirpc.resource
Members list
Type members
Classlikes
Alias is a description of an alias.
Alias is a description of an alias.
Attributes
- Companion
- object
- Supertypes
-
trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrortrait GeneratedMessageCompanion[Alias]trait Serializableclass Objecttrait Matchableclass AnyShow all
- Self type
-
Alias.type
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.
- parent
-
an optional parent URN that this child resource belongs to.
- 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.
- 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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ReadResourceRequest.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
-
ReadResourceResponse.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
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.
- 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.
- 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.
- parent
-
an optional parent URN that this child resource belongs to.
- 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.
- supportsPartialValues
-
true if the request is from an SDK that supports partially-known properties during preview.
- type
-
the type of the object allocated.
- urnAliases
-
a list of additional URNs that should be considered the same.
- version
-
the version of the provider to use when servicing this request.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[RegisterResourceRequest]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
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.
- 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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
Value parameters
- acceptResources
-
when true operations should return resource references as strongly typed.
- args
-
the arguments for the function invocation.
- 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.
- 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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
Attributes
- Supertypes
- Self type
-
ResourceMonitorGrpc.type
Attributes
- Supertypes
- Self type
-
ResourceProto.type
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 GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type
Value parameters
- hasSupport
-
true when the resource monitor supports this feature.
Attributes
- Companion
- object
- Supertypes
-
trait Updatable[SupportsFeatureResponse]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- class
- Supertypes
- Self type