io.envoyproxy.envoy.config.core.v4alpha

Enum ApiConfigSource.ApiType

java.lang.Object

java.lang.Enum<ApiConfigSource.ApiType>

io.envoyproxy.envoy.config.core.v4alpha.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 enum envoy.config.core.v4alpha.ApiConfigSource.ApiType

Enum Constant Summary

Enum Constants

Enum Constant and Description
AGGREGATED_DELTA_GRPC Delta xDS gRPC with ADS.
AGGREGATED_GRPC SotW xDS gRPC with ADS.
DELTA_GRPC Using the delta xDS gRPC service, i.e.
DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE Deprecated.
GRPC SotW gRPC service.
REST REST-JSON v2 API.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATED_DELTA_GRPC_VALUE Delta xDS gRPC with ADS.
static int	AGGREGATED_GRPC_VALUE SotW xDS gRPC with ADS.
static int	DELTA_GRPC_VALUE Using the delta xDS gRPC service, i.e.
static int	DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE_VALUE Ideally this would be 'reserved 0' but one can't reserve the default value.
static int	GRPC_VALUE SotW gRPC service.
static int	REST_VALUE REST-JSON v2 API.

Method Summary

Modifier and Type	Method and Description
static ApiConfigSource.ApiType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<ApiConfigSource.ApiType>	internalGetValueMap()
static ApiConfigSource.ApiType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static ApiConfigSource.ApiType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static ApiConfigSource.ApiType	valueOf(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.

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 Detail

DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE

@Deprecated
public static final ApiConfigSource.ApiType DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE

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.
 

DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE = 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

 SotW gRPC service.
 

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;

AGGREGATED_GRPC

public static final ApiConfigSource.ApiType AGGREGATED_GRPC

 SotW xDS gRPC with ADS. All resources which resolve to this configuration source will be
 multiplexed on a single connection to an ADS endpoint.
 [#not-implemented-hide:]
 

AGGREGATED_GRPC = 5;

AGGREGATED_DELTA_GRPC

public static final ApiConfigSource.ApiType AGGREGATED_DELTA_GRPC

 Delta xDS gRPC with ADS. All resources which resolve to this configuration source will be
 multiplexed on a single connection to an ADS endpoint.
 [#not-implemented-hide:]
 

AGGREGATED_DELTA_GRPC = 6;

UNRECOGNIZED

public static final ApiConfigSource.ApiType UNRECOGNIZED

Field Detail

DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE_VALUE

public static final int DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE_VALUE

 Ideally this would be 'reserved 0' but one can't reserve the default
 value. Instead we throw an exception if this is ever used.
 

DEPRECATED_AND_UNAVAILABLE_DO_NOT_USE = 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

 SotW gRPC service.
 

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

AGGREGATED_GRPC_VALUE

public static final int AGGREGATED_GRPC_VALUE

 SotW xDS gRPC with ADS. All resources which resolve to this configuration source will be
 multiplexed on a single connection to an ADS endpoint.
 [#not-implemented-hide:]
 

AGGREGATED_GRPC = 5;

See Also:

Constant Field Values

AGGREGATED_DELTA_GRPC_VALUE

public static final int AGGREGATED_DELTA_GRPC_VALUE

 Delta xDS gRPC with ADS. All resources which resolve to this configuration source will be
 multiplexed on a single connection to an ADS endpoint.
 [#not-implemented-hide:]
 

AGGREGATED_DELTA_GRPC = 6;

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 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 ApiConfigSource.ApiType valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static ApiConfigSource.ApiType forNumber(int value)

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<ApiConfigSource.ApiType> 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 ApiConfigSource.ApiType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)