API hub V1 API - Module Google::Cloud::ApiHub::V1::PluginInstance::State (v0.6.0)

Reference documentation and code samples for the API hub V1 API module Google::Cloud::ApiHub::V1::PluginInstance::State.

State represents the state of the plugin instance.

Constants

STATE_UNSPECIFIED

value: 0
Default unspecified state.

CREATING

value: 1
The plugin instance is being created.

ACTIVE

value: 2
The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.

APPLYING_CONFIG

value: 3
The updated config that contains additional_config and auth_config is being applied.

ERROR

value: 4
The ERROR state can come while applying config. Users can retrigger [ApplyPluginInstanceConfig][google.cloud.apihub.v1.ApiHubPlugin.ApplyPluginInstanceConfig] to restore the plugin instance back to active state. Note, In case the ERROR state happens while applying config (auth_config, additional_config), the plugin instance will reflect the config which was trying to be applied while error happened. In order to overwrite, trigger ApplyConfig with a new config.

FAILED

value: 5
The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).

DELETING

value: 6
The plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action.