Package io.envoyproxy.envoy.admin.v3
Interface ListenersConfigDump.DynamicListenerOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ListenersConfigDump.DynamicListener
,ListenersConfigDump.DynamicListener.Builder
- Enclosing class:
ListenersConfigDump
public static interface ListenersConfigDump.DynamicListenerOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThe listener state for any active listener by this name.The listener state for any active listener by this name.The client status of this resource.int
The client status of this resource.The listener state for any draining listener by this name.The listener state for any draining listener by this name.Set if the last update failed, cleared after the next successful update.Set if the last update failed, cleared after the next successful update.getName()
The name or unique id of this listener, pulled from the DynamicListenerState config.com.google.protobuf.ByteString
The name or unique id of this listener, pulled from the DynamicListenerState config.The listener state for any warming listener by this name.The listener state for any warming listener by this name.boolean
The listener state for any active listener by this name.boolean
The listener state for any draining listener by this name.boolean
Set if the last update failed, cleared after the next successful update.boolean
The listener state for any warming listener by this name.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getName
String getName()The name or unique id of this listener, pulled from the DynamicListenerState config.
string name = 1;
- Returns:
- The name.
-
getNameBytes
com.google.protobuf.ByteString getNameBytes()The name or unique id of this listener, pulled from the DynamicListenerState config.
string name = 1;
- Returns:
- The bytes for name.
-
hasActiveState
boolean hasActiveState()The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState active_state = 2;
- Returns:
- Whether the activeState field is set.
-
getActiveState
ListenersConfigDump.DynamicListenerState getActiveState()The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState active_state = 2;
- Returns:
- The activeState.
-
getActiveStateOrBuilder
ListenersConfigDump.DynamicListenerStateOrBuilder getActiveStateOrBuilder()The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState active_state = 2;
-
hasWarmingState
boolean hasWarmingState()The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState warming_state = 3;
- Returns:
- Whether the warmingState field is set.
-
getWarmingState
ListenersConfigDump.DynamicListenerState getWarmingState()The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState warming_state = 3;
- Returns:
- The warmingState.
-
getWarmingStateOrBuilder
ListenersConfigDump.DynamicListenerStateOrBuilder getWarmingStateOrBuilder()The listener state for any warming listener by this name. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState warming_state = 3;
-
hasDrainingState
boolean hasDrainingState()The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState draining_state = 4;
- Returns:
- Whether the drainingState field is set.
-
getDrainingState
ListenersConfigDump.DynamicListenerState getDrainingState()The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState draining_state = 4;
- Returns:
- The drainingState.
-
getDrainingStateOrBuilder
ListenersConfigDump.DynamicListenerStateOrBuilder getDrainingStateOrBuilder()The listener state for any draining listener by this name. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.
.envoy.admin.v3.ListenersConfigDump.DynamicListenerState draining_state = 4;
-
hasErrorState
boolean hasErrorState()Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty.
.envoy.admin.v3.UpdateFailureState error_state = 5;
- Returns:
- Whether the errorState field is set.
-
getErrorState
UpdateFailureState getErrorState()Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty.
.envoy.admin.v3.UpdateFailureState error_state = 5;
- Returns:
- The errorState.
-
getErrorStateOrBuilder
UpdateFailureStateOrBuilder getErrorStateOrBuilder()Set if the last update failed, cleared after the next successful update. The ``error_state`` field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty.
.envoy.admin.v3.UpdateFailureState error_state = 5;
-
getClientStatusValue
int getClientStatusValue()The client status of this resource. [#not-implemented-hide:]
.envoy.admin.v3.ClientResourceStatus client_status = 6;
- Returns:
- The enum numeric value on the wire for clientStatus.
-
getClientStatus
ClientResourceStatus getClientStatus()The client status of this resource. [#not-implemented-hide:]
.envoy.admin.v3.ClientResourceStatus client_status = 6;
- Returns:
- The clientStatus.
-