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

Class LbEndpoint.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LbEndpointOrBuilder, Cloneable
    Enclosing class:
    LbEndpoint
    public static final class LbEndpoint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<LbEndpoint.Builder>
implements LbEndpointOrBuilder
     An Endpoint that Envoy can route traffic to.
 [#next-free-field: 6]
    Protobuf type envoy.api.v2.endpoint.LbEndpoint

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

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

      • hasEndpoint

        public boolean hasEndpoint()
        .envoy.api.v2.endpoint.Endpoint endpoint = 1;
        Specified by:
        hasEndpoint in interface LbEndpointOrBuilder
        Returns:
        Whether the endpoint field is set.

      • clearEndpoint

        public LbEndpoint.Builder clearEndpoint()
        .envoy.api.v2.endpoint.Endpoint endpoint = 1;

      • getEndpointBuilder

        public Endpoint.Builder getEndpointBuilder()
        .envoy.api.v2.endpoint.Endpoint endpoint = 1;

      • hasEndpointName

        public boolean hasEndpointName()
         [#not-implemented-hide:]
        string endpoint_name = 5;
        Specified by:
        hasEndpointName in interface LbEndpointOrBuilder
        Returns:
        Whether the endpointName field is set.

      • getEndpointNameBytes

        public com.google.protobuf.ByteString getEndpointNameBytes()
         [#not-implemented-hide:]
        string endpoint_name = 5;
        Specified by:
        getEndpointNameBytes in interface LbEndpointOrBuilder
        Returns:
        The bytes for endpointName.

      • setEndpointName

        public LbEndpoint.Builder setEndpointName​(String value)
         [#not-implemented-hide:]
        string endpoint_name = 5;
        Parameters:
        value - The endpointName to set.
        Returns:
        This builder for chaining.

      • clearEndpointName

        public LbEndpoint.Builder clearEndpointName()
         [#not-implemented-hide:]
        string endpoint_name = 5;
        Returns:
        This builder for chaining.

      • setEndpointNameBytes

        public LbEndpoint.Builder setEndpointNameBytes​(com.google.protobuf.ByteString value)
         [#not-implemented-hide:]
        string endpoint_name = 5;
        Parameters:
        value - The bytes for endpointName to set.
        Returns:
        This builder for chaining.

      • getHealthStatusValue

        public int getHealthStatusValue()
         Optional health status when known and supplied by EDS server.
        .envoy.api.v2.core.HealthStatus health_status = 2;
        Specified by:
        getHealthStatusValue in interface LbEndpointOrBuilder
        Returns:
        The enum numeric value on the wire for healthStatus.

      • setHealthStatusValue

        public LbEndpoint.Builder setHealthStatusValue​(int value)
         Optional health status when known and supplied by EDS server.
        .envoy.api.v2.core.HealthStatus health_status = 2;
        Parameters:
        value - The enum numeric value on the wire for healthStatus to set.
        Returns:
        This builder for chaining.

      • getHealthStatus

        public HealthStatus getHealthStatus()
         Optional health status when known and supplied by EDS server.
        .envoy.api.v2.core.HealthStatus health_status = 2;
        Specified by:
        getHealthStatus in interface LbEndpointOrBuilder
        Returns:
        The healthStatus.

      • setHealthStatus

        public LbEndpoint.Builder setHealthStatus​(HealthStatus value)
         Optional health status when known and supplied by EDS server.
        .envoy.api.v2.core.HealthStatus health_status = 2;
        Parameters:
        value - The healthStatus to set.
        Returns:
        This builder for chaining.

      • clearHealthStatus

        public LbEndpoint.Builder clearHealthStatus()
         Optional health status when known and supplied by EDS server.
        .envoy.api.v2.core.HealthStatus health_status = 2;
        Returns:
        This builder for chaining.

      • hasMetadata

        public boolean hasMetadata()
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;
        Specified by:
        hasMetadata in interface LbEndpointOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public Metadata getMetadata()
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;
        Specified by:
        getMetadata in interface LbEndpointOrBuilder
        Returns:
        The metadata.

      • setMetadata

        public LbEndpoint.Builder setMetadata​(Metadata value)
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;

      • setMetadata

        public LbEndpoint.Builder setMetadata​(Metadata.Builder builderForValue)
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;

      • mergeMetadata

        public LbEndpoint.Builder mergeMetadata​(Metadata value)
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;

      • clearMetadata

        public LbEndpoint.Builder clearMetadata()
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;

      • getMetadataBuilder

        public Metadata.Builder getMetadataBuilder()
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;

      • getMetadataOrBuilder

        public MetadataOrBuilder getMetadataOrBuilder()
         The endpoint metadata specifies values that may be used by the load
 balancer to select endpoints in a cluster for a given request. The filter
 name should be specified as *envoy.lb*. An example boolean key-value pair
 is *canary*, providing the optional canary status of the upstream host.
 This may be matched against in a route's
 :ref:`RouteAction <envoy_api_msg_route.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
        .envoy.api.v2.core.Metadata metadata = 3;
        Specified by:
        getMetadataOrBuilder in interface LbEndpointOrBuilder

      • hasLoadBalancingWeight

        public boolean hasLoadBalancingWeight()
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }
        Specified by:
        hasLoadBalancingWeight in interface LbEndpointOrBuilder
        Returns:
        Whether the loadBalancingWeight field is set.

      • getLoadBalancingWeight

        public com.google.protobuf.UInt32Value getLoadBalancingWeight()
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }
        Specified by:
        getLoadBalancingWeight in interface LbEndpointOrBuilder
        Returns:
        The loadBalancingWeight.

      • setLoadBalancingWeight

        public LbEndpoint.Builder setLoadBalancingWeight​(com.google.protobuf.UInt32Value value)
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

      • setLoadBalancingWeight

        public LbEndpoint.Builder setLoadBalancingWeight​(com.google.protobuf.UInt32Value.Builder builderForValue)
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

      • mergeLoadBalancingWeight

        public LbEndpoint.Builder mergeLoadBalancingWeight​(com.google.protobuf.UInt32Value value)
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

      • clearLoadBalancingWeight

        public LbEndpoint.Builder clearLoadBalancingWeight()
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

      • getLoadBalancingWeightBuilder

        public com.google.protobuf.UInt32Value.Builder getLoadBalancingWeightBuilder()
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }

      • getLoadBalancingWeightOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()
         The optional load balancing weight of the upstream host; at least 1.
 Envoy uses the load balancing weight in some of the built in load
 balancers. The load balancing weight for an endpoint is divided by the sum
 of the weights of all endpoints in the endpoint's locality to produce a
 percentage of traffic for the endpoint. This percentage is then further
 weighted by the endpoint's locality's load balancing weight from
 LocalityLbEndpoints. If unspecified, each host is presumed to have equal
 weight in a locality. The sum of the weights of all endpoints in the
 endpoint's locality must not exceed uint32_t maximal value (4294967295).
        .google.protobuf.UInt32Value load_balancing_weight = 4 [(.validate.rules) = { ... }
        Specified by:
        getLoadBalancingWeightOrBuilder in interface LbEndpointOrBuilder

      • setUnknownFields

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

      • mergeUnknownFields

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