Package com.google.cloud.eventarc.v1
Enum Channel.State
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<Channel.State>
- Enclosing class:
- Channel
public static enum Channel.State
extends Enum<Channel.State>
implements com.google.protobuf.ProtocolMessageEnum
State lists all the possible states of a ChannelProtobuf enum
google.cloud.eventarc.v1.Channel.State-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe ACTIVE state indicates that a Channel has been successfully connected with the event provider.The INACTIVE state indicates that the Channel cannot receive events permanently.The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.Default value. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe ACTIVE state indicates that a Channel has been successfully connected with the event provider.static final intThe INACTIVE state indicates that the Channel cannot receive events permanently.static final intThe PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.static final intDefault value. -
Method Summary
Modifier and TypeMethodDescriptionstatic Channel.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<Channel.State>static Channel.StatevalueOf(int value) Deprecated.static Channel.StatevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc) Returns the enum constant of this type with the specified name.static Channel.StateReturns the enum constant of this type with the specified name.static Channel.State[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
STATE_UNSPECIFIED
Default value. This value is unused.
STATE_UNSPECIFIED = 0; -
PENDING
The PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.
PENDING = 1; -
ACTIVE
The ACTIVE state indicates that a Channel has been successfully connected with the event provider. An ACTIVE Channel is ready to receive and route events from the event provider.
ACTIVE = 2; -
INACTIVE
The INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen: 1. The SaaS provider disconnected from this Channel. 2. The Channel activation token has expired but the SaaS provider wasn't connected. To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider.
INACTIVE = 3; -
UNRECOGNIZED
-
-
Field Details
-
STATE_UNSPECIFIED_VALUE
public static final int STATE_UNSPECIFIED_VALUEDefault value. This value is unused.
STATE_UNSPECIFIED = 0;- See Also:
-
PENDING_VALUE
public static final int PENDING_VALUEThe PENDING state indicates that a Channel has been created successfully and there is a new activation token available for the subscriber to use to convey the Channel to the provider in order to create a Connection.
PENDING = 1;- See Also:
-
ACTIVE_VALUE
public static final int ACTIVE_VALUEThe ACTIVE state indicates that a Channel has been successfully connected with the event provider. An ACTIVE Channel is ready to receive and route events from the event provider.
ACTIVE = 2;- See Also:
-
INACTIVE_VALUE
public static final int INACTIVE_VALUEThe INACTIVE state indicates that the Channel cannot receive events permanently. There are two possible cases this state can happen: 1. The SaaS provider disconnected from this Channel. 2. The Channel activation token has expired but the SaaS provider wasn't connected. To re-establish a Connection with a provider, the subscriber should create a new Channel and give it to the provider.
INACTIVE = 3;- 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
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
-