Package io.envoyproxy.envoy.config.endpoint.v3

Class LbEndpoint.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<LbEndpoint.Builder>
com.google.protobuf.GeneratedMessage.Builder<LbEndpoint.Builder>
io.envoyproxy.envoy.config.endpoint.v3.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.GeneratedMessage.Builder<LbEndpoint.Builder> implements LbEndpointOrBuilder
 An Endpoint that Envoy can route traffic to.
 [#next-free-field: 6]
Protobuf type envoy.config.endpoint.v3.LbEndpoint

  • Field Details

    • hostIdentifierCase_

      private int hostIdentifierCase_

    • hostIdentifier_

      private Object hostIdentifier_

    • bitField0_

      private int bitField0_

    • endpointBuilder_

      private com.google.protobuf.SingleFieldBuilder<Endpoint,Endpoint.Builder,EndpointOrBuilder> endpointBuilder_

    • healthStatus_

      private int healthStatus_

    • metadata_

      private Metadata metadata_

    • metadataBuilder_

      private com.google.protobuf.SingleFieldBuilder<Metadata,Metadata.Builder,MetadataOrBuilder> metadataBuilder_

    • loadBalancingWeight_

      private com.google.protobuf.UInt32Value loadBalancingWeight_

    • loadBalancingWeightBuilder_

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,com.google.protobuf.UInt32Value.Builder,com.google.protobuf.UInt32ValueOrBuilder> loadBalancingWeightBuilder_

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • maybeForceBuilderInitialization

      private void maybeForceBuilderInitialization()

    • 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.GeneratedMessage.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.GeneratedMessage.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

    • buildPartial0

      private void buildPartial0(LbEndpoint result)

    • buildPartialOneofs

      private void buildPartialOneofs(LbEndpoint result)

    • 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>

    • mergeFrom

      public LbEndpoint.Builder mergeFrom(LbEndpoint other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.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

    • getHostIdentifierCase

      public LbEndpoint.HostIdentifierCase getHostIdentifierCase()
      Specified by:
      getHostIdentifierCase in interface LbEndpointOrBuilder

    • clearHostIdentifier

      public LbEndpoint.Builder clearHostIdentifier()

    • hasEndpoint

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

    • getEndpoint

      public Endpoint getEndpoint()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      Specified by:
      getEndpoint in interface LbEndpointOrBuilder
      Returns:
      The endpoint.

    • setEndpoint

      public LbEndpoint.Builder setEndpoint(Endpoint value)
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;

    • setEndpoint

      public LbEndpoint.Builder setEndpoint(Endpoint.Builder builderForValue)
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;

    • mergeEndpoint

      public LbEndpoint.Builder mergeEndpoint(Endpoint value)
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;

    • clearEndpoint

      public LbEndpoint.Builder clearEndpoint()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;

    • getEndpointBuilder

      public Endpoint.Builder getEndpointBuilder()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;

    • getEndpointOrBuilder

      public EndpointOrBuilder getEndpointOrBuilder()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      Specified by:
      getEndpointOrBuilder in interface LbEndpointOrBuilder

    • getEndpointFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<Endpoint,Endpoint.Builder,EndpointOrBuilder> getEndpointFieldBuilder()
      .envoy.config.endpoint.v3.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.

    • getEndpointName

      public String getEndpointName()
       [#not-implemented-hide:]
      string endpoint_name = 5;
      Specified by:
      getEndpointName in interface LbEndpointOrBuilder
      Returns:
      The endpointName.

    • 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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.Metadata metadata = 3;
      Specified by:
      getMetadataOrBuilder in interface LbEndpointOrBuilder

    • getMetadataFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<Metadata,Metadata.Builder,MetadataOrBuilder> getMetadataFieldBuilder()
       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_v3_api_msg_config.route.v3.RouteAction>` metadata_match field
 to subset the endpoints considered in cluster load balancing.
      .envoy.config.core.v3.Metadata metadata = 3;

    • 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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, will be treated as 1. 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

    • getLoadBalancingWeightFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,com.google.protobuf.UInt32Value.Builder,com.google.protobuf.UInt32ValueOrBuilder> getLoadBalancingWeightFieldBuilder()
       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, will be treated as 1. 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) = { ... }