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

Class LbEndpoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, LbEndpointOrBuilder, java.io.Serializable
    public final class LbEndpoint
extends com.google.protobuf.GeneratedMessage
implements LbEndpointOrBuilder
     An Endpoint that Envoy can route traffic to.
 [#next-free-field: 6]
    Protobuf type envoy.config.endpoint.v3.LbEndpoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  LbEndpoint.Builder
      An Endpoint that Envoy can route traffic to.
      static class  LbEndpoint.HostIdentifierCase  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private LbEndpoint()  
      private LbEndpoint​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static LbEndpoint getDefaultInstance()  
      LbEndpoint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      Endpoint getEndpoint()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      java.lang.String getEndpointName()
      [#not-implemented-hide:]
      com.google.protobuf.ByteString getEndpointNameBytes()
      [#not-implemented-hide:]
      EndpointOrBuilder getEndpointOrBuilder()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      HealthStatus getHealthStatus()
      Optional health status when known and supplied by EDS server.
      int getHealthStatusValue()
      Optional health status when known and supplied by EDS server.
      LbEndpoint.HostIdentifierCase getHostIdentifierCase()  
      com.google.protobuf.UInt32Value getLoadBalancingWeight()
      The optional load balancing weight of the upstream host; at least 1.
      com.google.protobuf.UInt32ValueOrBuilder getLoadBalancingWeightOrBuilder()
      The optional load balancing weight of the upstream host; at least 1.
      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.
      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.
      com.google.protobuf.Parser<LbEndpoint> getParserForType()  
      int getSerializedSize()  
      boolean hasEndpoint()
      .envoy.config.endpoint.v3.Endpoint endpoint = 1;
      boolean hasEndpointName()
      [#not-implemented-hide:]
      int hashCode()  
      boolean hasLoadBalancingWeight()
      The optional load balancing weight of the upstream host; at least 1.
      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.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static LbEndpoint.Builder newBuilder()  
      static LbEndpoint.Builder newBuilder​(LbEndpoint prototype)  
      LbEndpoint.Builder newBuilderForType()  
      protected LbEndpoint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static LbEndpoint parseDelimitedFrom​(java.io.InputStream input)  
      static LbEndpoint parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LbEndpoint parseFrom​(byte[] data)  
      static LbEndpoint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LbEndpoint parseFrom​(com.google.protobuf.ByteString data)  
      static LbEndpoint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LbEndpoint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static LbEndpoint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LbEndpoint parseFrom​(java.io.InputStream input)  
      static LbEndpoint parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static LbEndpoint parseFrom​(java.nio.ByteBuffer data)  
      static LbEndpoint parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<LbEndpoint> parser()  
      LbEndpoint.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • bitField0_

        private int bitField0_

      • hostIdentifierCase_

        private int hostIdentifierCase_

      • hostIdentifier_

        private java.lang.Object hostIdentifier_

      • ENDPOINT_NAME_FIELD_NUMBER

        public static final int ENDPOINT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEALTH_STATUS_FIELD_NUMBER

        public static final int HEALTH_STATUS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • healthStatus_

        private int healthStatus_

      • LOAD_BALANCING_WEIGHT_FIELD_NUMBER

        public static final int LOAD_BALANCING_WEIGHT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • loadBalancingWeight_

        private com.google.protobuf.UInt32Value loadBalancingWeight_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final LbEndpoint DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<LbEndpoint> PARSER

    • Constructor Detail

      • LbEndpoint

        private LbEndpoint​(com.google.protobuf.GeneratedMessage.Builder<?> builder)

      • LbEndpoint

        private LbEndpoint()

    • Method Detail

      • 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

      • hasEndpoint

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

      • 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 java.lang.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.

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

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

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

      • 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

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

      • 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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • equals

        public boolean equals​(java.lang.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 LbEndpoint parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LbEndpoint parseFrom​(java.io.InputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static LbEndpoint parseFrom​(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static LbEndpoint parseDelimitedFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static LbEndpoint parseDelimitedFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static LbEndpoint parseFrom​(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static LbEndpoint parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected LbEndpoint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static LbEndpoint getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<LbEndpoint> parser()

      • getParserForType

        public com.google.protobuf.Parser<LbEndpoint> 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.GeneratedMessage

      • getDefaultInstanceForType

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