Attributes
- Companion
- object
- Graph
-
- Supertypes
-
trait ResourceProvidertrait AbstractServiceclass AbstractStub[ResourceProviderStub]class Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Attach sends the engine address to an already running plugin.
Attach sends the engine address to an already running plugin.
Attributes
- Definition Classes
Attributes
- Definition Classes
-
AbstractStub
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
- Definition Classes
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
- Definition Classes
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
- Definition Classes
CheckConfig validates the configuration for this resource provider.
CheckConfig validates the configuration for this resource provider.
Attributes
- Definition Classes
Configure configures the resource provider with "globals" that control its behavior.
Configure configures the resource provider with "globals" that control its behavior.
Attributes
- Definition Classes
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
- Definition Classes
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
- Definition Classes
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
- Definition Classes
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
- Definition Classes
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
- Definition Classes
GetPluginInfo returns generic information about this plugin, like its version.
GetPluginInfo returns generic information about this plugin, like its version.
Attributes
- Definition Classes
GetSchema fetches the schema for this resource provider.
GetSchema fetches the schema for this resource provider.
Attributes
- Definition Classes
Invoke dynamically executes a built-in function in the provider.
Invoke dynamically executes a built-in function in the provider.
Attributes
- Definition Classes
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
- Definition Classes
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
- Definition Classes
Update updates an existing resource with new values.
Inherited methods
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Definition Classes
- Inherited from:
- ResourceProvider
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Attributes
- Inherited from:
- AbstractStub
Deprecated and Inherited methods
Attributes
- Deprecated
- true
- Inherited from:
- AbstractStub