Package io.envoyproxy.envoy.api.v2.endpoint

Class LocalityLbEndpoints.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LocalityLbEndpointsOrBuilder, Cloneable
    Enclosing class:
    LocalityLbEndpoints
    public static final class LocalityLbEndpoints.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LocalityLbEndpoints.Builder>
implements LocalityLbEndpointsOrBuilder
     A group of endpoints belonging to a Locality.
 One can have multiple LocalityLbEndpoints for a locality, but this is
 generally only done if the different groups need to have different load
 balancing weights or different priorities.
 [#next-free-field: 7]
    Protobuf type envoy.api.v2.endpoint.LocalityLbEndpoints

    • Method Detail

      • 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.Builder<LocalityLbEndpoints.Builder>

      • clear

        public LocalityLbEndpoints.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<LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • setField

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

      • clearField

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • clearOneof

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • setRepeatedField

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • addRepeatedField

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • mergeFrom

        public LocalityLbEndpoints.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<LocalityLbEndpoints.Builder>

      • isInitialized

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

      • mergeFrom

        public LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>
        Throws:
        IOException

      • hasLocality

        public boolean hasLocality()
         Identifies location of where the upstream hosts run.
        .envoy.api.v2.core.Locality locality = 1;
        Specified by:
        hasLocality in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the locality field is set.

      • setLocality

        public LocalityLbEndpoints.Builder setLocality​(Locality value)
         Identifies location of where the upstream hosts run.
        .envoy.api.v2.core.Locality locality = 1;

      • mergeLocality

        public LocalityLbEndpoints.Builder mergeLocality​(Locality value)
         Identifies location of where the upstream hosts run.
        .envoy.api.v2.core.Locality locality = 1;

      • clearLocality

        public LocalityLbEndpoints.Builder clearLocality()
         Identifies location of where the upstream hosts run.
        .envoy.api.v2.core.Locality locality = 1;

      • getLocalityBuilder

        public Locality.Builder getLocalityBuilder()
         Identifies location of where the upstream hosts run.
        .envoy.api.v2.core.Locality locality = 1;

      • getLbEndpointsCount

        public int getLbEndpointsCount()
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;
        Specified by:
        getLbEndpointsCount in interface LocalityLbEndpointsOrBuilder

      • getLbEndpoints

        public LbEndpoint getLbEndpoints​(int index)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;
        Specified by:
        getLbEndpoints in interface LocalityLbEndpointsOrBuilder

      • setLbEndpoints

        public LocalityLbEndpoints.Builder setLbEndpoints​(int index,
                                                  LbEndpoint value)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • setLbEndpoints

        public LocalityLbEndpoints.Builder setLbEndpoints​(int index,
                                                  LbEndpoint.Builder builderForValue)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpoints

        public LocalityLbEndpoints.Builder addLbEndpoints​(LbEndpoint value)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpoints

        public LocalityLbEndpoints.Builder addLbEndpoints​(int index,
                                                  LbEndpoint value)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpoints

        public LocalityLbEndpoints.Builder addLbEndpoints​(LbEndpoint.Builder builderForValue)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpoints

        public LocalityLbEndpoints.Builder addLbEndpoints​(int index,
                                                  LbEndpoint.Builder builderForValue)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addAllLbEndpoints

        public LocalityLbEndpoints.Builder addAllLbEndpoints​(Iterable<? extends LbEndpoint> values)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • clearLbEndpoints

        public LocalityLbEndpoints.Builder clearLbEndpoints()
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • removeLbEndpoints

        public LocalityLbEndpoints.Builder removeLbEndpoints​(int index)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • getLbEndpointsBuilder

        public LbEndpoint.Builder getLbEndpointsBuilder​(int index)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpointsBuilder

        public LbEndpoint.Builder addLbEndpointsBuilder()
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • addLbEndpointsBuilder

        public LbEndpoint.Builder addLbEndpointsBuilder​(int index)
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • getLbEndpointsBuilderList

        public List<LbEndpoint.Builder> getLbEndpointsBuilderList()
         The group of endpoints belonging to the locality specified.
        repeated .envoy.api.v2.endpoint.LbEndpoint lb_endpoints = 2;

      • hasLoadBalancingWeight

        public boolean hasLoadBalancingWeight()
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }
        Specified by:
        hasLoadBalancingWeight in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the loadBalancingWeight field is set.

      • getLoadBalancingWeight

        public com.google.protobuf.UInt32Value getLoadBalancingWeight()
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }
        Specified by:
        getLoadBalancingWeight in interface LocalityLbEndpointsOrBuilder
        Returns:
        The loadBalancingWeight.

      • setLoadBalancingWeight

        public LocalityLbEndpoints.Builder setLoadBalancingWeight​(com.google.protobuf.UInt32Value value)
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }

      • setLoadBalancingWeight

        public LocalityLbEndpoints.Builder setLoadBalancingWeight​(com.google.protobuf.UInt32Value.Builder builderForValue)
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }

      • mergeLoadBalancingWeight

        public LocalityLbEndpoints.Builder mergeLoadBalancingWeight​(com.google.protobuf.UInt32Value value)
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }

      • clearLoadBalancingWeight

        public LocalityLbEndpoints.Builder clearLoadBalancingWeight()
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }

      • getLoadBalancingWeightBuilder

        public com.google.protobuf.UInt32Value.Builder getLoadBalancingWeightBuilder()
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }

      • getLoadBalancingWeightOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()
         Optional: Per priority/region/zone/sub_zone weight; at least 1. The load
 balancing weight for a locality is divided by the sum of the weights of all
 localities  at the same priority level to produce the effective percentage
 of traffic for the locality. The sum of the weights of all localities at
 the same priority level must not exceed uint32_t maximal value (4294967295).
 Locality weights are only considered when :ref:`locality weighted load
 balancing <arch_overview_load_balancing_locality_weighted_lb>` is
 configured. These weights are ignored otherwise. If no weights are
 specified when locality weighted load balancing is enabled, the locality is
 assigned no load.
        .google.protobuf.UInt32Value load_balancing_weight = 3 [(.validate.rules) = { ... }
        Specified by:
        getLoadBalancingWeightOrBuilder in interface LocalityLbEndpointsOrBuilder

      • getPriority

        public int getPriority()
         Optional: the priority for this LocalityLbEndpoints. If unspecified this will
 default to the highest priority (0).
 Under usual circumstances, Envoy will only select endpoints for the highest
 priority (0). In the event all endpoints for a particular priority are
 unavailable/unhealthy, Envoy will fail over to selecting endpoints for the
 next highest priority group.
 Priorities should range from 0 (highest) to N (lowest) without skipping.
        uint32 priority = 5 [(.validate.rules) = { ... }
        Specified by:
        getPriority in interface LocalityLbEndpointsOrBuilder
        Returns:
        The priority.

      • setPriority

        public LocalityLbEndpoints.Builder setPriority​(int value)
         Optional: the priority for this LocalityLbEndpoints. If unspecified this will
 default to the highest priority (0).
 Under usual circumstances, Envoy will only select endpoints for the highest
 priority (0). In the event all endpoints for a particular priority are
 unavailable/unhealthy, Envoy will fail over to selecting endpoints for the
 next highest priority group.
 Priorities should range from 0 (highest) to N (lowest) without skipping.
        uint32 priority = 5 [(.validate.rules) = { ... }
        Parameters:
        value - The priority to set.
        Returns:
        This builder for chaining.

      • clearPriority

        public LocalityLbEndpoints.Builder clearPriority()
         Optional: the priority for this LocalityLbEndpoints. If unspecified this will
 default to the highest priority (0).
 Under usual circumstances, Envoy will only select endpoints for the highest
 priority (0). In the event all endpoints for a particular priority are
 unavailable/unhealthy, Envoy will fail over to selecting endpoints for the
 next highest priority group.
 Priorities should range from 0 (highest) to N (lowest) without skipping.
        uint32 priority = 5 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • hasProximity

        public boolean hasProximity()
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;
        Specified by:
        hasProximity in interface LocalityLbEndpointsOrBuilder
        Returns:
        Whether the proximity field is set.

      • getProximity

        public com.google.protobuf.UInt32Value getProximity()
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;
        Specified by:
        getProximity in interface LocalityLbEndpointsOrBuilder
        Returns:
        The proximity.

      • setProximity

        public LocalityLbEndpoints.Builder setProximity​(com.google.protobuf.UInt32Value value)
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;

      • setProximity

        public LocalityLbEndpoints.Builder setProximity​(com.google.protobuf.UInt32Value.Builder builderForValue)
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;

      • mergeProximity

        public LocalityLbEndpoints.Builder mergeProximity​(com.google.protobuf.UInt32Value value)
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;

      • clearProximity

        public LocalityLbEndpoints.Builder clearProximity()
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;

      • getProximityBuilder

        public com.google.protobuf.UInt32Value.Builder getProximityBuilder()
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;

      • getProximityOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getProximityOrBuilder()
         Optional: Per locality proximity value which indicates how close this
 locality is from the source locality. This value only provides ordering
 information (lower the value, closer it is to the source locality).
 This will be consumed by load balancing schemes that need proximity order
 to determine where to route the requests.
 [#not-implemented-hide:]
        .google.protobuf.UInt32Value proximity = 6;
        Specified by:
        getProximityOrBuilder in interface LocalityLbEndpointsOrBuilder

      • setUnknownFields

        public final LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>

      • mergeUnknownFields

        public final LocalityLbEndpoints.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<LocalityLbEndpoints.Builder>