Package io.envoyproxy.envoy.api.v2.core
Enum ApiConfigSource.ApiType
- java.lang.Object
-
- java.lang.Enum<ApiConfigSource.ApiType>
-
- io.envoyproxy.envoy.api.v2.core.ApiConfigSource.ApiType
-
- All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite,com.google.protobuf.ProtocolMessageEnum,Serializable,Comparable<ApiConfigSource.ApiType>
- Enclosing class:
- ApiConfigSource
public static enum ApiConfigSource.ApiType extends Enum<ApiConfigSource.ApiType> implements com.google.protobuf.ProtocolMessageEnum
APIs may be fetched via either REST or gRPC.
Protobuf enumenvoy.api.v2.core.ApiConfigSource.ApiType
-
-
Enum Constant Summary
Enum Constants Enum Constant Description DELTA_GRPCUsing the delta xDS gRPC service, i.e.GRPCgRPC v2 API.RESTREST-JSON v2 API.UNRECOGNIZEDUNSUPPORTED_REST_LEGACYDeprecated.
-
Field Summary
Fields Modifier and Type Field Description static intDELTA_GRPC_VALUEUsing the delta xDS gRPC service, i.e.static intGRPC_VALUEgRPC v2 API.static intREST_VALUEREST-JSON v2 API.static intUNSUPPORTED_REST_LEGACY_VALUEDeprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ApiConfigSource.ApiTypeforNumber(int value)static com.google.protobuf.Descriptors.EnumDescriptorgetDescriptor()com.google.protobuf.Descriptors.EnumDescriptorgetDescriptorForType()intgetNumber()com.google.protobuf.Descriptors.EnumValueDescriptorgetValueDescriptor()static com.google.protobuf.Internal.EnumLiteMap<ApiConfigSource.ApiType>internalGetValueMap()static ApiConfigSource.ApiTypevalueOf(int value)Deprecated.static ApiConfigSource.ApiTypevalueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)Returns the enum constant of this type with the specified name.static ApiConfigSource.ApiTypevalueOf(String name)Returns the enum constant of this type with the specified name.static ApiConfigSource.ApiType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UNSUPPORTED_REST_LEGACY
@Deprecated public static final ApiConfigSource.ApiType UNSUPPORTED_REST_LEGACY
Deprecated.Ideally this would be 'reserved 0' but one can't reserve the default value. Instead we throw an exception if this is ever used.
UNSUPPORTED_REST_LEGACY = 0 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];
-
REST
public static final ApiConfigSource.ApiType REST
REST-JSON v2 API. The `canonical JSON encoding <https://developers.google.com/protocol-buffers/docs/proto3#json>`_ for the v2 protos is used.
REST = 1;
-
GRPC
public static final ApiConfigSource.ApiType GRPC
gRPC v2 API.
GRPC = 2;
-
DELTA_GRPC
public static final ApiConfigSource.ApiType DELTA_GRPC
Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response} rather than Discovery{Request,Response}. Rather than sending Envoy the entire state with every update, the xDS server only sends what has changed since the last update.DELTA_GRPC = 3;
-
UNRECOGNIZED
public static final ApiConfigSource.ApiType UNRECOGNIZED
-
-
Field Detail
-
UNSUPPORTED_REST_LEGACY_VALUE
@Deprecated public static final int UNSUPPORTED_REST_LEGACY_VALUE
Deprecated.Ideally this would be 'reserved 0' but one can't reserve the default value. Instead we throw an exception if this is ever used.
UNSUPPORTED_REST_LEGACY = 0 [deprecated = true, (.envoy.annotations.disallowed_by_default_enum) = true];- See Also:
- Constant Field Values
-
REST_VALUE
public static final int REST_VALUE
REST-JSON v2 API. The `canonical JSON encoding <https://developers.google.com/protocol-buffers/docs/proto3#json>`_ for the v2 protos is used.
REST = 1;- See Also:
- Constant Field Values
-
GRPC_VALUE
public static final int GRPC_VALUE
gRPC v2 API.
GRPC = 2;- See Also:
- Constant Field Values
-
DELTA_GRPC_VALUE
public static final int DELTA_GRPC_VALUE
Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response} rather than Discovery{Request,Response}. Rather than sending Envoy the entire state with every update, the xDS server only sends what has changed since the last update.DELTA_GRPC = 3;- See Also:
- Constant Field Values
-
-
Method Detail
-
values
public static ApiConfigSource.ApiType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (ApiConfigSource.ApiType c : ApiConfigSource.ApiType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ApiConfigSource.ApiType 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 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 public static ApiConfigSource.ApiType 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 nameNullPointerException- if the argument is null
-
forNumber
public static ApiConfigSource.ApiType 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<ApiConfigSource.ApiType> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
-
valueOf
public static ApiConfigSource.ApiType 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
-
-