Google Cloud Api Hub V1 Client - Class State (0.4.1)

Reference documentation and code samples for the Google Cloud Api Hub V1 Client class State.

State represents the state of the plugin instance.

Protobuf type google.cloud.apihub.v1.PluginInstance.State

Namespace

Google \ Cloud \ ApiHub \ V1 \ PluginInstance

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

Default unspecified state.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

CREATING

Value: 1

The plugin instance is being created.

Generated from protobuf enum CREATING = 1;

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.

Generated from protobuf enum ACTIVE = 2;

APPLYING_CONFIG

Value: 3

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

Generated from protobuf enum APPLYING_CONFIG = 3;

ERROR

Value: 4

The ERROR state can come while applying config. Users can retrigger 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.

Generated from protobuf enum ERROR = 4;

FAILED

Value: 5

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

Generated from protobuf enum FAILED = 5;

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.

Generated from protobuf enum DELETING = 6;