Package io.envoyproxy.envoy.api.v2

Class ClusterLoadAssignment.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ClusterLoadAssignmentOrBuilder, Cloneable
    Enclosing class:
    ClusterLoadAssignment
    public static final class ClusterLoadAssignment.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>
implements ClusterLoadAssignmentOrBuilder
     Each route from RDS will map to a single cluster or traffic split across
 clusters using weights expressed in the RDS WeightedCluster.
 With EDS, each cluster is treated independently from a LB perspective, with
 LB taking place between the Localities within a cluster and at a finer
 granularity between the hosts within a locality. The percentage of traffic
 for each endpoint is determined by both its load_balancing_weight, and the
 load_balancing_weight of its locality. First, a locality will be selected,
 then an endpoint within that locality will be chose based on its weight.
 [#next-free-field: 6]
    Protobuf type envoy.api.v2.ClusterLoadAssignment

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • clear

        public ClusterLoadAssignment.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • getDefaultInstanceForType

        public ClusterLoadAssignment getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ClusterLoadAssignment build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ClusterLoadAssignment buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ClusterLoadAssignment.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • clearField

        public ClusterLoadAssignment.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • clearOneof

        public ClusterLoadAssignment.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • setRepeatedField

        public ClusterLoadAssignment.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • addRepeatedField

        public ClusterLoadAssignment.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • mergeFrom

        public ClusterLoadAssignment.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ClusterLoadAssignment.Builder>
        Throws:
        IOException

      • getClusterName

        public String getClusterName()
         Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
        string cluster_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getClusterName in interface ClusterLoadAssignmentOrBuilder
        Returns:
        The clusterName.

      • getClusterNameBytes

        public com.google.protobuf.ByteString getClusterNameBytes()
         Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
        string cluster_name = 1 [(.validate.rules) = { ... }
        Specified by:
        getClusterNameBytes in interface ClusterLoadAssignmentOrBuilder
        Returns:
        The bytes for clusterName.

      • setClusterName

        public ClusterLoadAssignment.Builder setClusterName​(String value)
         Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
        string cluster_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The clusterName to set.
        Returns:
        This builder for chaining.

      • clearClusterName

        public ClusterLoadAssignment.Builder clearClusterName()
         Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
        string cluster_name = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setClusterNameBytes

        public ClusterLoadAssignment.Builder setClusterNameBytes​(com.google.protobuf.ByteString value)
         Name of the cluster. This will be the :ref:`service_name
 <envoy_api_field_Cluster.EdsClusterConfig.service_name>` value if specified
 in the cluster :ref:`EdsClusterConfig
 <envoy_api_msg_Cluster.EdsClusterConfig>`.
        string cluster_name = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for clusterName to set.
        Returns:
        This builder for chaining.

      • getEndpointsCount

        public int getEndpointsCount()
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;
        Specified by:
        getEndpointsCount in interface ClusterLoadAssignmentOrBuilder

      • clearEndpoints

        public ClusterLoadAssignment.Builder clearEndpoints()
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • removeEndpoints

        public ClusterLoadAssignment.Builder removeEndpoints​(int index)
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • getEndpointsBuilder

        public LocalityLbEndpoints.Builder getEndpointsBuilder​(int index)
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • addEndpointsBuilder

        public LocalityLbEndpoints.Builder addEndpointsBuilder()
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • addEndpointsBuilder

        public LocalityLbEndpoints.Builder addEndpointsBuilder​(int index)
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • getEndpointsBuilderList

        public List<LocalityLbEndpoints.Builder> getEndpointsBuilderList()
         List of endpoints to load balance to.
        repeated .envoy.api.v2.endpoint.LocalityLbEndpoints endpoints = 2;

      • containsNamedEndpoints

        public boolean containsNamedEndpoints​(String key)
         Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
        map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;
        Specified by:
        containsNamedEndpoints in interface ClusterLoadAssignmentOrBuilder

      • removeNamedEndpoints

        public ClusterLoadAssignment.Builder removeNamedEndpoints​(String key)
         Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
        map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

      • getMutableNamedEndpoints

        @Deprecated
public Map<String,​Endpoint> getMutableNamedEndpoints()
        Deprecated.
        Use alternate mutation accessors instead.

      • putNamedEndpoints

        public ClusterLoadAssignment.Builder putNamedEndpoints​(String key,
                                                       Endpoint value)
         Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
        map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

      • putAllNamedEndpoints

        public ClusterLoadAssignment.Builder putAllNamedEndpoints​(Map<String,​Endpoint> values)
         Map of named endpoints that can be referenced in LocalityLbEndpoints.
 [#not-implemented-hide:]
        map<string, .envoy.api.v2.endpoint.Endpoint> named_endpoints = 5;

      • hasPolicy

        public boolean hasPolicy()
         Load balancing policy settings.
        .envoy.api.v2.ClusterLoadAssignment.Policy policy = 4;
        Specified by:
        hasPolicy in interface ClusterLoadAssignmentOrBuilder
        Returns:
        Whether the policy field is set.

      • clearPolicy

        public ClusterLoadAssignment.Builder clearPolicy()
         Load balancing policy settings.
        .envoy.api.v2.ClusterLoadAssignment.Policy policy = 4;

      • setUnknownFields

        public final ClusterLoadAssignment.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>

      • mergeUnknownFields

        public final ClusterLoadAssignment.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ClusterLoadAssignment.Builder>