Package io.envoyproxy.envoy.config.bootstrap.v2

Class 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

    • 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
        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_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
        Returns:
        The bytes for localClusterName.

      • 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
        Returns:
        Whether the outlierDetection field is set.

      • 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
        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.api.v2.core.BindConfig upstream_bind_config = 3;
        Specified by:
        getUpstreamBindConfig in interface ClusterManagerOrBuilder
        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.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
        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_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
        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_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​(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

      • 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