Class ClusterManager
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.bootstrap.v3.ClusterManager
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ClusterManagerOrBuilder
,java.io.Serializable
public final class ClusterManager extends com.google.protobuf.GeneratedMessage implements ClusterManagerOrBuilder
Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`. [#next-free-field: 6]
Protobuf typeenvoy.config.bootstrap.v3.ClusterManager
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ClusterManager.Builder
Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`.static class
ClusterManager.OutlierDetection
Protobuf typeenvoy.config.bootstrap.v3.ClusterManager.OutlierDetection
static interface
ClusterManager.OutlierDetectionOrBuilder
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static ClusterManager
DEFAULT_INSTANCE
static int
ENABLE_DEFERRED_CLUSTER_CREATION_FIELD_NUMBER
private boolean
enableDeferredClusterCreation_
static int
LOAD_STATS_CONFIG_FIELD_NUMBER
private ApiConfigSource
loadStatsConfig_
static int
LOCAL_CLUSTER_NAME_FIELD_NUMBER
private java.lang.Object
localClusterName_
private byte
memoizedIsInitialized
static int
OUTLIER_DETECTION_FIELD_NUMBER
private ClusterManager.OutlierDetection
outlierDetection_
private static com.google.protobuf.Parser<ClusterManager>
PARSER
private static long
serialVersionUID
static int
UPSTREAM_BIND_CONFIG_FIELD_NUMBER
private BindConfig
upstreamBindConfig_
-
Constructor Summary
Constructors Modifier Constructor Description private
ClusterManager()
private
ClusterManager(com.google.protobuf.GeneratedMessage.Builder<?> builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static ClusterManager
getDefaultInstance()
ClusterManager
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
boolean
getEnableDeferredClusterCreation()
Whether the ClusterManager will create clusters on the worker threads inline during requests.ApiConfigSource
getLoadStatsConfig()
A management server endpoint to stream load stats to via ``StreamLoadStats``.ApiConfigSourceOrBuilder
getLoadStatsConfigOrBuilder()
A management server endpoint to stream load stats to via ``StreamLoadStats``.java.lang.String
getLocalClusterName()
Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration).com.google.protobuf.ByteString
getLocalClusterNameBytes()
Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration).ClusterManager.OutlierDetection
getOutlierDetection()
Optional global configuration for outlier detection.ClusterManager.OutlierDetectionOrBuilder
getOutlierDetectionOrBuilder()
Optional global configuration for outlier detection.com.google.protobuf.Parser<ClusterManager>
getParserForType()
int
getSerializedSize()
BindConfig
getUpstreamBindConfig()
Optional configuration used to bind newly established upstream connections.BindConfigOrBuilder
getUpstreamBindConfigOrBuilder()
Optional configuration used to bind newly established upstream connections.int
hashCode()
boolean
hasLoadStatsConfig()
A management server endpoint to stream load stats to via ``StreamLoadStats``.boolean
hasOutlierDetection()
Optional global configuration for outlier detection.boolean
hasUpstreamBindConfig()
Optional configuration used to bind newly established upstream connections.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static ClusterManager.Builder
newBuilder()
static ClusterManager.Builder
newBuilder(ClusterManager prototype)
ClusterManager.Builder
newBuilderForType()
protected ClusterManager.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static ClusterManager
parseDelimitedFrom(java.io.InputStream input)
static ClusterManager
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterManager
parseFrom(byte[] data)
static ClusterManager
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterManager
parseFrom(com.google.protobuf.ByteString data)
static ClusterManager
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterManager
parseFrom(com.google.protobuf.CodedInputStream input)
static ClusterManager
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterManager
parseFrom(java.io.InputStream input)
static ClusterManager
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ClusterManager
parseFrom(java.nio.ByteBuffer data)
static ClusterManager
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ClusterManager>
parser()
ClusterManager.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
LOCAL_CLUSTER_NAME_FIELD_NUMBER
public static final int LOCAL_CLUSTER_NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
localClusterName_
private volatile java.lang.Object localClusterName_
-
OUTLIER_DETECTION_FIELD_NUMBER
public static final int OUTLIER_DETECTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
outlierDetection_
private ClusterManager.OutlierDetection outlierDetection_
-
UPSTREAM_BIND_CONFIG_FIELD_NUMBER
public static final int UPSTREAM_BIND_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
upstreamBindConfig_
private BindConfig upstreamBindConfig_
-
LOAD_STATS_CONFIG_FIELD_NUMBER
public static final int LOAD_STATS_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
loadStatsConfig_
private ApiConfigSource loadStatsConfig_
-
ENABLE_DEFERRED_CLUSTER_CREATION_FIELD_NUMBER
public static final int ENABLE_DEFERRED_CLUSTER_CREATION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
enableDeferredClusterCreation_
private boolean enableDeferredClusterCreation_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final ClusterManager DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<ClusterManager> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getLocalClusterName
public java.lang.String getLocalClusterName()
Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration). In order to enable :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>` this option must be set. If ``local_cluster_name`` is defined then :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>` must be defined in the :ref:`Bootstrap static cluster resources <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.StaticResources.clusters>`. This is unrelated to the :option:`--service-cluster` option which does not `affect zone aware routing <https://github.com/envoyproxy/envoy/issues/774>`_.
string local_cluster_name = 1;
- Specified by:
getLocalClusterName
in interfaceClusterManagerOrBuilder
- Returns:
- The localClusterName.
-
getLocalClusterNameBytes
public com.google.protobuf.ByteString getLocalClusterNameBytes()
Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration). In order to enable :ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>` this option must be set. If ``local_cluster_name`` is defined then :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>` must be defined in the :ref:`Bootstrap static cluster resources <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.StaticResources.clusters>`. This is unrelated to the :option:`--service-cluster` option which does not `affect zone aware routing <https://github.com/envoyproxy/envoy/issues/774>`_.
string local_cluster_name = 1;
- Specified by:
getLocalClusterNameBytes
in interfaceClusterManagerOrBuilder
- Returns:
- The bytes for localClusterName.
-
hasOutlierDetection
public boolean hasOutlierDetection()
Optional global configuration for outlier detection.
.envoy.config.bootstrap.v3.ClusterManager.OutlierDetection outlier_detection = 2;
- Specified by:
hasOutlierDetection
in interfaceClusterManagerOrBuilder
- Returns:
- Whether the outlierDetection field is set.
-
getOutlierDetection
public ClusterManager.OutlierDetection getOutlierDetection()
Optional global configuration for outlier detection.
.envoy.config.bootstrap.v3.ClusterManager.OutlierDetection outlier_detection = 2;
- Specified by:
getOutlierDetection
in interfaceClusterManagerOrBuilder
- Returns:
- The outlierDetection.
-
getOutlierDetectionOrBuilder
public ClusterManager.OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()
Optional global configuration for outlier detection.
.envoy.config.bootstrap.v3.ClusterManager.OutlierDetection outlier_detection = 2;
- Specified by:
getOutlierDetectionOrBuilder
in interfaceClusterManagerOrBuilder
-
hasUpstreamBindConfig
public boolean hasUpstreamBindConfig()
Optional configuration used to bind newly established upstream connections. This may be overridden on a per-cluster basis by upstream_bind_config in the cds_config.
.envoy.config.core.v3.BindConfig upstream_bind_config = 3;
- Specified by:
hasUpstreamBindConfig
in interfaceClusterManagerOrBuilder
- Returns:
- Whether the upstreamBindConfig field is set.
-
getUpstreamBindConfig
public BindConfig getUpstreamBindConfig()
Optional configuration used to bind newly established upstream connections. This may be overridden on a per-cluster basis by upstream_bind_config in the cds_config.
.envoy.config.core.v3.BindConfig upstream_bind_config = 3;
- Specified by:
getUpstreamBindConfig
in interfaceClusterManagerOrBuilder
- Returns:
- The upstreamBindConfig.
-
getUpstreamBindConfigOrBuilder
public BindConfigOrBuilder getUpstreamBindConfigOrBuilder()
Optional configuration used to bind newly established upstream connections. This may be overridden on a per-cluster basis by upstream_bind_config in the cds_config.
.envoy.config.core.v3.BindConfig upstream_bind_config = 3;
- Specified by:
getUpstreamBindConfigOrBuilder
in interfaceClusterManagerOrBuilder
-
hasLoadStatsConfig
public boolean hasLoadStatsConfig()
A management server endpoint to stream load stats to via ``StreamLoadStats``. This must have :ref:`api_type <envoy_v3_api_field_config.core.v3.ApiConfigSource.api_type>` :ref:`GRPC <envoy_v3_api_enum_value_config.core.v3.ApiConfigSource.ApiType.GRPC>`.
.envoy.config.core.v3.ApiConfigSource load_stats_config = 4;
- Specified by:
hasLoadStatsConfig
in interfaceClusterManagerOrBuilder
- Returns:
- Whether the loadStatsConfig field is set.
-
getLoadStatsConfig
public ApiConfigSource getLoadStatsConfig()
A management server endpoint to stream load stats to via ``StreamLoadStats``. This must have :ref:`api_type <envoy_v3_api_field_config.core.v3.ApiConfigSource.api_type>` :ref:`GRPC <envoy_v3_api_enum_value_config.core.v3.ApiConfigSource.ApiType.GRPC>`.
.envoy.config.core.v3.ApiConfigSource load_stats_config = 4;
- Specified by:
getLoadStatsConfig
in interfaceClusterManagerOrBuilder
- Returns:
- The loadStatsConfig.
-
getLoadStatsConfigOrBuilder
public ApiConfigSourceOrBuilder getLoadStatsConfigOrBuilder()
A management server endpoint to stream load stats to via ``StreamLoadStats``. This must have :ref:`api_type <envoy_v3_api_field_config.core.v3.ApiConfigSource.api_type>` :ref:`GRPC <envoy_v3_api_enum_value_config.core.v3.ApiConfigSource.ApiType.GRPC>`.
.envoy.config.core.v3.ApiConfigSource load_stats_config = 4;
- Specified by:
getLoadStatsConfigOrBuilder
in interfaceClusterManagerOrBuilder
-
getEnableDeferredClusterCreation
public boolean getEnableDeferredClusterCreation()
Whether the ClusterManager will create clusters on the worker threads inline during requests. This will save memory and CPU cycles in cases where there are lots of inactive clusters and > 1 worker thread.
bool enable_deferred_cluster_creation = 5;
- Specified by:
getEnableDeferredClusterCreation
in interfaceClusterManagerOrBuilder
- Returns:
- The enableDeferredClusterCreation.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ClusterManager parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ClusterManager parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ClusterManager parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static ClusterManager parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public ClusterManager.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static ClusterManager.Builder newBuilder()
-
newBuilder
public static ClusterManager.Builder newBuilder(ClusterManager prototype)
-
toBuilder
public ClusterManager.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ClusterManager.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static ClusterManager getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<ClusterManager> parser()
-
getParserForType
public com.google.protobuf.Parser<ClusterManager> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public ClusterManager getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-