Package io.envoyproxy.envoy.api.v2.core

Enum ApiVersion

java.lang.Object
java.lang.Enum<ApiVersion>
io.envoyproxy.envoy.api.v2.core.ApiVersion
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<ApiVersion>, java.lang.constant.Constable
public enum ApiVersion extends Enum<ApiVersion> implements com.google.protobuf.ProtocolMessageEnum
 xDS API version. This is used to describe both resource and transport
 protocol versions (in distinct configuration fields).
Protobuf enum envoy.api.v2.core.ApiVersion

  • Enum Constant Details

    • AUTO

      @Deprecated public static final ApiVersion AUTO
      Deprecated.
       When not specified, we assume v2, to ease migration to Envoy's stable API
 versioning. If a client does not support v2 (e.g. due to deprecation), this
 is an invalid value.
      AUTO = 0 [deprecated = true];

    • V2

      @Deprecated public static final ApiVersion V2
      Deprecated.
       Use xDS v2 API.
      V2 = 1 [deprecated = true];

    • V3

      public static final ApiVersion V3
       Use xDS v3 API.
      V3 = 2;

    • UNRECOGNIZED

      public static final ApiVersion UNRECOGNIZED

  • Field Details

    • AUTO_VALUE

      @Deprecated public static final int AUTO_VALUE
      Deprecated.
       When not specified, we assume v2, to ease migration to Envoy's stable API
 versioning. If a client does not support v2 (e.g. due to deprecation), this
 is an invalid value.
      AUTO = 0 [deprecated = true];
      See Also:

    • V2_VALUE

      @Deprecated public static final int V2_VALUE
      Deprecated.
       Use xDS v2 API.
      V2 = 1 [deprecated = true];
      See Also:

    • V3_VALUE

      public static final int V3_VALUE
       Use xDS v3 API.
      V3 = 2;
      See Also:

  • Method Details

    • values

      public static ApiVersion[] 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 ApiVersion 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 ApiVersion 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 ApiVersion 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<ApiVersion> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static ApiVersion 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