io.envoyproxy.envoy.config.bootstrap.v2

Class ClusterManager

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.config.bootstrap.v2.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.GeneratedMessageV3
implements ClusterManagerOrBuilder

 Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`.
 

Protobuf type envoy.config.bootstrap.v2.ClusterManager

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClusterManager.Builder Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`.
static class	ClusterManager.OutlierDetection Protobuf type envoy.config.bootstrap.v2.ClusterManager.OutlierDetection
static interface	ClusterManager.OutlierDetectionOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOAD_STATS_CONFIG_FIELD_NUMBER
static int	LOCAL_CLUSTER_NAME_FIELD_NUMBER
static int	OUTLIER_DETECTION_FIELD_NUMBER
static int	UPSTREAM_BIND_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ClusterManager	getDefaultInstance()
ClusterManager	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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*.
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()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ClusterManager.Builder	newBuilder()
static ClusterManager.Builder	newBuilder(ClusterManager prototype)
ClusterManager.Builder	newBuilderForType()
protected ClusterManager.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
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(ByteBuffer data)
static ClusterManager	parseFrom(ByteBuffer 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 com.google.protobuf.Parser<ClusterManager>	parser()
ClusterManager.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

LOCAL_CLUSTER_NAME_FIELD_NUMBER

public static final int LOCAL_CLUSTER_NAME_FIELD_NUMBER

See Also:

Constant Field Values

OUTLIER_DETECTION_FIELD_NUMBER

public static final int OUTLIER_DETECTION_FIELD_NUMBER

See Also:

Constant Field Values

UPSTREAM_BIND_CONFIG_FIELD_NUMBER

public static final int UPSTREAM_BIND_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

LOAD_STATS_CONFIG_FIELD_NUMBER

public static final int LOAD_STATS_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getLocalClusterName

public 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_api_msg_Cluster>` must be defined in the :ref:`Bootstrap
 static cluster resources
 <envoy_api_field_config.bootstrap.v2.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 interface ClusterManagerOrBuilder

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_api_msg_Cluster>` must be defined in the :ref:`Bootstrap
 static cluster resources
 <envoy_api_field_config.bootstrap.v2.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 interface ClusterManagerOrBuilder

hasOutlierDetection

public boolean hasOutlierDetection()

 Optional global configuration for outlier detection.
 

.envoy.config.bootstrap.v2.ClusterManager.OutlierDetection outlier_detection = 2;

Specified by:

hasOutlierDetection in interface ClusterManagerOrBuilder

getOutlierDetection

public ClusterManager.OutlierDetection getOutlierDetection()

 Optional global configuration for outlier detection.
 

.envoy.config.bootstrap.v2.ClusterManager.OutlierDetection outlier_detection = 2;

Specified by:

getOutlierDetection in interface ClusterManagerOrBuilder

getOutlierDetectionOrBuilder

public ClusterManager.OutlierDetectionOrBuilder getOutlierDetectionOrBuilder()

 Optional global configuration for outlier detection.
 

.envoy.config.bootstrap.v2.ClusterManager.OutlierDetection outlier_detection = 2;

Specified by:

getOutlierDetectionOrBuilder in interface ClusterManagerOrBuilder

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.api.v2.core.BindConfig upstream_bind_config = 3;

Specified by:

hasUpstreamBindConfig in interface ClusterManagerOrBuilder

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.api.v2.core.BindConfig upstream_bind_config = 3;

Specified by:

getUpstreamBindConfig in interface ClusterManagerOrBuilder

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.api.v2.core.BindConfig upstream_bind_config = 3;

Specified by:

getUpstreamBindConfigOrBuilder in interface ClusterManagerOrBuilder

hasLoadStatsConfig

public boolean hasLoadStatsConfig()

 A management server endpoint to stream load stats to via
 *StreamLoadStats*. This must have :ref:`api_type
 <envoy_api_field_core.ApiConfigSource.api_type>` :ref:`GRPC
 <envoy_api_enum_value_core.ApiConfigSource.ApiType.GRPC>`.
 

.envoy.api.v2.core.ApiConfigSource load_stats_config = 4;

Specified by:

hasLoadStatsConfig in interface ClusterManagerOrBuilder

getLoadStatsConfig

public ApiConfigSource getLoadStatsConfig()

 A management server endpoint to stream load stats to via
 *StreamLoadStats*. This must have :ref:`api_type
 <envoy_api_field_core.ApiConfigSource.api_type>` :ref:`GRPC
 <envoy_api_enum_value_core.ApiConfigSource.ApiType.GRPC>`.
 

.envoy.api.v2.core.ApiConfigSource load_stats_config = 4;

Specified by:

getLoadStatsConfig in interface ClusterManagerOrBuilder

getLoadStatsConfigOrBuilder

public ApiConfigSourceOrBuilder getLoadStatsConfigOrBuilder()

 A management server endpoint to stream load stats to via
 *StreamLoadStats*. This must have :ref:`api_type
 <envoy_api_field_core.ApiConfigSource.api_type>` :ref:`GRPC
 <envoy_api_enum_value_core.ApiConfigSource.ApiType.GRPC>`.
 

.envoy.api.v2.core.ApiConfigSource load_stats_config = 4;

Specified by:

getLoadStatsConfigOrBuilder in interface ClusterManagerOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.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

public static ClusterManager parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ClusterManager parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ClusterManager parseDelimitedFrom(InputStream input)
                                         throws IOException

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

public ClusterManager.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.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 interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ClusterManager.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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 interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ClusterManager getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder