Package com.google.cloud.apihub.v1
Enum PluginInstance.State
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<PluginInstance.State>
- Enclosing class:
- PluginInstance
public static enum PluginInstance.State
extends Enum<PluginInstance.State>
implements com.google.protobuf.ProtocolMessageEnum
State represents the state of the plugin instance.Protobuf enum
google.cloud.apihub.v1.PluginInstance.State-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe plugin instance is active and ready for executions.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.The plugin instance is being created.The plugin instance is being deleted.The ERROR state can come while applying config.The plugin instance is in a failed state.Default unspecified state. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe plugin instance is active and ready for executions.static final intThe 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.static final intThe plugin instance is being created.static final intThe plugin instance is being deleted.static final intThe ERROR state can come while applying config.static final intThe plugin instance is in a failed state.static final intDefault unspecified state. -
Method Summary
Modifier and TypeMethodDescriptionstatic PluginInstance.StateforNumber(int value) static com.google.protobuf.Descriptors.EnumDescriptorfinal com.google.protobuf.Descriptors.EnumDescriptorfinal intfinal com.google.protobuf.Descriptors.EnumValueDescriptorstatic com.google.protobuf.Internal.EnumLiteMap<PluginInstance.State>static PluginInstance.StatevalueOf(int value) Deprecated.static PluginInstance.StatevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static PluginInstance.StateReturns the enum constant of this type with the specified name.static PluginInstance.State[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
STATE_UNSPECIFIED
Default unspecified state.
STATE_UNSPECIFIED = 0; -
CREATING
The plugin instance is being created.
CREATING = 1; -
ACTIVE
The plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.
ACTIVE = 2; -
APPLYING_CONFIG
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.
APPLYING_CONFIG = 3; -
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.
ERROR = 4; -
FAILED
The plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).
FAILED = 5; -
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.
DELETING = 6; -
UNRECOGNIZED
-
-
Field Details
-
STATE_UNSPECIFIED_VALUE
public static final int STATE_UNSPECIFIED_VALUEDefault unspecified state.
STATE_UNSPECIFIED = 0;- See Also:
-
CREATING_VALUE
public static final int CREATING_VALUEThe plugin instance is being created.
CREATING = 1;- See Also:
-
ACTIVE_VALUE
public static final int ACTIVE_VALUEThe plugin instance is active and ready for executions. This is the only state where executions can run on the plugin instance.
ACTIVE = 2;- See Also:
-
APPLYING_CONFIG_VALUE
public static final int APPLYING_CONFIG_VALUEThe 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.
APPLYING_CONFIG = 3;- See Also:
-
ERROR_VALUE
public static final int ERROR_VALUEThe 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.
ERROR = 4;- See Also:
-
FAILED_VALUE
public static final int FAILED_VALUEThe plugin instance is in a failed state. This indicates that an unrecoverable error occurred during a previous operation (Create, Delete).
FAILED = 5;- See Also:
-
DELETING_VALUE
public static final int DELETING_VALUEThe plugin instance is being deleted. Delete is only possible if there is no other operation running on the plugin instance and plugin instance action.
DELETING = 6;- See Also:
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
getNumber
public final int getNumber()- Specified by:
getNumberin interfacecom.google.protobuf.Internal.EnumLite- Specified by:
getNumberin interfacecom.google.protobuf.ProtocolMessageEnum
-
valueOf
Deprecated.Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
value- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
forNumber
- Parameters:
value- The numeric wire value of the corresponding enum entry.- Returns:
- The enum associated with the given numeric wire value.
-
internalGetValueMap
-
getValueDescriptor
public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()- Specified by:
getValueDescriptorin interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptorForType
public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.ProtocolMessageEnum
-
getDescriptor
public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor() -
valueOf
public static PluginInstance.State valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
desc- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-