ResourceProviderBlockingClient

pulumirpc.provider.ResourceProviderGrpc.ResourceProviderBlockingClient

ResourceProvider is a service that understands how to create, read, update, or delete resources for types defined within a single package. It is driven by the overall planning engine in response to resource diffs.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Abstract methods

Attach sends the engine address to an already running plugin.

Attach sends the engine address to an already running plugin.

Attributes

Call dynamically executes a method in the provider associated with a component resource.

Call dynamically executes a method in the provider associated with a component resource.

Attributes

Cancel signals the provider to gracefully shut down and abort any ongoing resource operations. Operations aborted in this way will return an error (e.g., Update and Create will either return a creation error or an initialization error). Since Cancel is advisory and non-blocking, it is up to the host to decide how long to wait after Cancel is called before (e.g.) hard-closing any gRPC connection.

Cancel signals the provider to gracefully shut down and abort any ongoing resource operations. Operations aborted in this way will return an error (e.g., Update and Create will either return a creation error or an initialization error). Since Cancel is advisory and non-blocking, it is up to the host to decide how long to wait after Cancel is called before (e.g.) hard-closing any gRPC connection.

Attributes

Check validates that the given property bag is valid for a resource of the given type and returns the inputs that should be passed to successive calls to Diff, Create, or Update for this resource. As a rule, the provider inputs returned by a call to Check should preserve the original representation of the properties as present in the program inputs. Though this rule is not required for correctness, violations thereof can negatively impact the end-user experience, as the provider inputs are using for detecting and rendering diffs.

Check validates that the given property bag is valid for a resource of the given type and returns the inputs that should be passed to successive calls to Diff, Create, or Update for this resource. As a rule, the provider inputs returned by a call to Check should preserve the original representation of the properties as present in the program inputs. Though this rule is not required for correctness, violations thereof can negatively impact the end-user experience, as the provider inputs are using for detecting and rendering diffs.

Attributes

CheckConfig validates the configuration for this resource provider.

CheckConfig validates the configuration for this resource provider.

Attributes

Configure configures the resource provider with "globals" that control its behavior.

Configure configures the resource provider with "globals" that control its behavior.

Attributes

Construct creates a new instance of the provided component resource and returns its state.

Construct creates a new instance of the provided component resource and returns its state.

Attributes

Create allocates a new instance of the provided resource and returns its unique ID afterwards. (The input ID must be blank.) If this call fails, the resource must not have been created (i.e., it is "transactional").

Create allocates a new instance of the provided resource and returns its unique ID afterwards. (The input ID must be blank.) If this call fails, the resource must not have been created (i.e., it is "transactional").

Attributes

Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

Delete tears down an existing resource with the given ID. If it fails, the resource is assumed to still exist.

Attributes

Diff checks what impacts a hypothetical update will have on the resource's properties.

Diff checks what impacts a hypothetical update will have on the resource's properties.

Attributes

DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider.

DiffConfig checks the impact a hypothetical change to this provider's configuration will have on the provider.

Attributes

GetMapping fetches the mapping for this resource provider, if any. A provider should return an empty response (not an error) if it doesn't have a mapping for the given key.

GetMapping fetches the mapping for this resource provider, if any. A provider should return an empty response (not an error) if it doesn't have a mapping for the given key.

Attributes

GetMappings is an optional method that returns what mappings (if any) a provider supports. If a provider does not implement this method the engine falls back to the old behaviour of just calling GetMapping without a name. If this method is implemented than the engine will then call GetMapping only with the names returned from this method.

GetMappings is an optional method that returns what mappings (if any) a provider supports. If a provider does not implement this method the engine falls back to the old behaviour of just calling GetMapping without a name. If this method is implemented than the engine will then call GetMapping only with the names returned from this method.

Attributes

GetPluginInfo returns generic information about this plugin, like its version.

GetPluginInfo returns generic information about this plugin, like its version.

Attributes

GetSchema fetches the schema for this resource provider.

GetSchema fetches the schema for this resource provider.

Attributes

Invoke dynamically executes a built-in function in the provider.

Invoke dynamically executes a built-in function in the provider.

Attributes

Read the current live state associated with a resource. Enough state must be include in the inputs to uniquely identify the resource; this is typically just the resource ID, but may also include some properties.

Read the current live state associated with a resource. Enough state must be include in the inputs to uniquely identify the resource; this is typically just the resource ID, but may also include some properties.

Attributes

StreamInvoke dynamically executes a built-in function in the provider, which returns a stream of responses.

StreamInvoke dynamically executes a built-in function in the provider, which returns a stream of responses.

Attributes

Update updates an existing resource with new values.

Update updates an existing resource with new values.

Attributes