Enum Channel.State

java.lang.Object
java.lang.Enum<Channel.State>
com.google.cloud.eventarc.v1.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 Channel
 
Protobuf enum google.cloud.eventarc.v1.Channel.State
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    The 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    The ACTIVE state indicates that a Channel has been successfully connected with the event provider.
    static final int
    The INACTIVE state indicates that the Channel cannot receive events permanently.
    static final int
    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.
    static final int
    Default value.
  • Method Summary

    Modifier and Type
    Method
    Description
    forNumber(int value)
     
    static com.google.protobuf.Descriptors.EnumDescriptor
     
    final com.google.protobuf.Descriptors.EnumDescriptor
     
    final int
     
    final com.google.protobuf.Descriptors.EnumValueDescriptor
     
    static com.google.protobuf.Internal.EnumLiteMap<Channel.State>
     
    valueOf(int value)
    Deprecated.
    valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
    Returns the enum constant of this type with the specified name.
    Returns the enum constant of this type with the specified name.
    static Channel.State[]
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • STATE_UNSPECIFIED

      public static final Channel.State STATE_UNSPECIFIED
       Default value. This value is unused.
       
      STATE_UNSPECIFIED = 0;
    • PENDING

      public static final Channel.State 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

      public static final Channel.State 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

      public static final Channel.State 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

      public static final Channel.State UNRECOGNIZED
  • Field Details

    • STATE_UNSPECIFIED_VALUE

      public static final int STATE_UNSPECIFIED_VALUE
       Default value. This value is unused.
       
      STATE_UNSPECIFIED = 0;
      See Also:
    • PENDING_VALUE

      public static final int PENDING_VALUE
       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;
      See Also:
    • ACTIVE_VALUE

      public static final int ACTIVE_VALUE
       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;
      See Also:
    • INACTIVE_VALUE

      public static final int INACTIVE_VALUE
       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;
      See Also:
  • Method Details

    • values

      public static Channel.State[] 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

      public static Channel.State valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum
    • valueOf

      @Deprecated public static Channel.State valueOf(int value)
      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 name
      NullPointerException - if the argument is null
    • forNumber

      public static Channel.State forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.
    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<Channel.State> internalGetValueMap()
    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
    • valueOf

      public static Channel.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 name
      NullPointerException - if the argument is null