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
,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 type
envoy.config.bootstrap.v3.ClusterManager
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`.static final class
Protobuf typeenvoy.config.bootstrap.v3.ClusterManager.OutlierDetection
static interface
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParent
Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
private static final ClusterManager
static final int
private boolean
static final int
private ApiConfigSource
static final int
private Object
private byte
static final int
private ClusterManager.OutlierDetection
private static final com.google.protobuf.Parser
<ClusterManager> private static final long
static final int
private BindConfig
Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
private
ClusterManager
(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
static ClusterManager
static final com.google.protobuf.Descriptors.Descriptor
boolean
Whether the ClusterManager will create clusters on the worker threads inline during requests.A management server endpoint to stream load stats to via ``StreamLoadStats``.A management server endpoint to stream load stats to via ``StreamLoadStats``.Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration).com.google.protobuf.ByteString
Name of the local cluster (i.e., the cluster that owns the Envoy running this configuration).Optional global configuration for outlier detection.Optional global configuration for outlier detection.com.google.protobuf.Parser
<ClusterManager> int
Optional configuration used to bind newly established upstream connections.Optional configuration used to bind newly established upstream connections.int
hashCode()
boolean
A management server endpoint to stream load stats to via ``StreamLoadStats``.boolean
Optional global configuration for outlier detection.boolean
Optional configuration used to bind newly established upstream connections.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
final boolean
static ClusterManager.Builder
static ClusterManager.Builder
newBuilder
(ClusterManager prototype) protected ClusterManager.Builder
newBuilderForType
(com.google.protobuf.AbstractMessage.BuilderParent parent) static ClusterManager
parseDelimitedFrom
(InputStream input) static ClusterManager
parseDelimitedFrom
(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
(InputStream input) static ClusterManager
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ClusterManager
parseFrom
(ByteBuffer data) static ClusterManager
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser
<ClusterManager> parser()
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
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
LOCAL_CLUSTER_NAME_FIELD_NUMBER
public static final int LOCAL_CLUSTER_NAME_FIELD_NUMBER- See Also:
-
localClusterName_
-
OUTLIER_DETECTION_FIELD_NUMBER
public static final int OUTLIER_DETECTION_FIELD_NUMBER- See Also:
-
outlierDetection_
-
UPSTREAM_BIND_CONFIG_FIELD_NUMBER
public static final int UPSTREAM_BIND_CONFIG_FIELD_NUMBER- See Also:
-
upstreamBindConfig_
-
LOAD_STATS_CONFIG_FIELD_NUMBER
public static final int LOAD_STATS_CONFIG_FIELD_NUMBER- See Also:
-
loadStatsConfig_
-
ENABLE_DEFERRED_CLUSTER_CREATION_FIELD_NUMBER
public static final int ENABLE_DEFERRED_CLUSTER_CREATION_FIELD_NUMBER- See Also:
-
enableDeferredClusterCreation_
private boolean enableDeferredClusterCreation_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
ClusterManager
private ClusterManager(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
ClusterManager
private ClusterManager()
-
-
Method Details
-
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
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
Optional global configuration for outlier detection.
.envoy.config.bootstrap.v3.ClusterManager.OutlierDetection outlier_detection = 2;
- Specified by:
getOutlierDetection
in interfaceClusterManagerOrBuilder
- Returns:
- The outlierDetection.
-
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
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
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
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
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
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
- 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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ClusterManager parseFrom(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
- Throws:
IOException
-
parseFrom
public static ClusterManager parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ClusterManager parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ClusterManager parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
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
-
parser
-
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
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-