API hub v1 API - Enum PluginInstance.Types.State (1.1.0)

public enum PluginInstance.Types.State

Reference documentation and code samples for the API hub v1 API enum PluginInstance.Types.State.

State represents the state of the plugin instance.

Namespace

Google.Cloud.ApiHub.V1

Assembly

Google.Cloud.ApiHub.V1.dll

Fields

Name Description
Active

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

ApplyingConfig

The updated config that contains [additional_config][google.cloud.apihub.v1.PluginInstance.additional_config] and [auth_config][google.cloud.apihub.v1.PluginInstance.auth_config] is being applied.

Creating

The plugin instance is being created.

Deleting

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.

Error

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

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

Unspecified

Default unspecified state.