io.envoyproxy.envoy.config.listener.v3

Enum Listener.DrainType

java.lang.Object

java.lang.Enum<Listener.DrainType>

io.envoyproxy.envoy.config.listener.v3.Listener.DrainType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<Listener.DrainType>

Enclosing class:

Listener

public static enum Listener.DrainType
extends Enum<Listener.DrainType>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum envoy.config.listener.v3.Listener.DrainType

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Drain in response to calling /healthcheck/fail admin endpoint (along with the health check filter), listener removal/modification, and hot restart.
MODIFY_ONLY Drain in response to listener removal/modification and hot restart.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VALUE Drain in response to calling /healthcheck/fail admin endpoint (along with the health check filter), listener removal/modification, and hot restart.
static int	MODIFY_ONLY_VALUE Drain in response to listener removal/modification and hot restart.

Method Summary

Modifier and Type	Method and Description
static Listener.DrainType	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<Listener.DrainType>	internalGetValueMap()
static Listener.DrainType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static Listener.DrainType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static Listener.DrainType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Listener.DrainType[]	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

DEFAULT

public static final Listener.DrainType DEFAULT

 Drain in response to calling /healthcheck/fail admin endpoint (along with the health check
 filter), listener removal/modification, and hot restart.
 

DEFAULT = 0;

MODIFY_ONLY

public static final Listener.DrainType MODIFY_ONLY

 Drain in response to listener removal/modification and hot restart. This setting does not
 include /healthcheck/fail. This setting may be desirable if Envoy is hosting both ingress
 and egress listeners.
 

MODIFY_ONLY = 1;

UNRECOGNIZED

public static final Listener.DrainType UNRECOGNIZED

Field Detail

DEFAULT_VALUE

public static final int DEFAULT_VALUE

 Drain in response to calling /healthcheck/fail admin endpoint (along with the health check
 filter), listener removal/modification, and hot restart.
 

DEFAULT = 0;

See Also:

Constant Field Values

MODIFY_ONLY_VALUE

public static final int MODIFY_ONLY_VALUE

 Drain in response to listener removal/modification and hot restart. This setting does not
 include /healthcheck/fail. This setting may be desirable if Envoy is hosting both ingress
 and egress listeners.
 

MODIFY_ONLY = 1;

See Also:

Constant Field Values

Method Detail

values

public static Listener.DrainType[] 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 (Listener.DrainType c : Listener.DrainType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Listener.DrainType 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 Listener.DrainType valueOf(int value)

Deprecated. Use forNumber(int) instead.

forNumber

public static Listener.DrainType forNumber(int value)

internalGetValueMap

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