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

Class Endpoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EndpointOrBuilder, Serializable
    public final class Endpoint
extends com.google.protobuf.GeneratedMessageV3
implements EndpointOrBuilder
     Upstream host identifier.
    Protobuf type envoy.api.v2.endpoint.Endpoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Endpoint.Builder
      Upstream host identifier.
      static class  Endpoint.HealthCheckConfig
      The optional health check configuration.
      static interface  Endpoint.HealthCheckConfigOrBuilder  

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ADDRESS_FIELD_NUMBER  
      static int HEALTH_CHECK_CONFIG_FIELD_NUMBER  
      static int HOSTNAME_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      Address getAddress()
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      AddressOrBuilder getAddressOrBuilder()
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      static Endpoint getDefaultInstance()  
      Endpoint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      Endpoint.HealthCheckConfig getHealthCheckConfig()
      The optional health check configuration is used as configuration for the health checker to contact the health checked host. .. attention:: This takes into effect only for upstream clusters with :ref:`active health checking <arch_overview_health_checking>` enabled.
      Endpoint.HealthCheckConfigOrBuilder getHealthCheckConfigOrBuilder()
      The optional health check configuration is used as configuration for the health checker to contact the health checked host. .. attention:: This takes into effect only for upstream clusters with :ref:`active health checking <arch_overview_health_checking>` enabled.
      String getHostname()
      The hostname associated with this endpoint.
      com.google.protobuf.ByteString getHostnameBytes()
      The hostname associated with this endpoint.
      com.google.protobuf.Parser<Endpoint> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasAddress()
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      int hashCode()  
      boolean hasHealthCheckConfig()
      The optional health check configuration is used as configuration for the health checker to contact the health checked host. .. attention:: This takes into effect only for upstream clusters with :ref:`active health checking <arch_overview_health_checking>` enabled.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Endpoint.Builder newBuilder()  
      static Endpoint.Builder newBuilder​(Endpoint prototype)  
      Endpoint.Builder newBuilderForType()  
      protected Endpoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Endpoint parseDelimitedFrom​(InputStream input)  
      static Endpoint parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Endpoint parseFrom​(byte[] data)  
      static Endpoint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Endpoint parseFrom​(com.google.protobuf.ByteString data)  
      static Endpoint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Endpoint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Endpoint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Endpoint parseFrom​(InputStream input)  
      static Endpoint parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Endpoint parseFrom​(ByteBuffer data)  
      static Endpoint parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Endpoint> parser()  
      Endpoint.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • 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, hasField, hasOneof

    • Field Detail

      • HEALTH_CHECK_CONFIG_FIELD_NUMBER

        public static final int HEALTH_CHECK_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • hasAddress

        public boolean hasAddress()
         The upstream host address.
 .. attention::
   The form of host address depends on the given cluster type. For STATIC or EDS,
   it is expected to be a direct IP address (or something resolvable by the
   specified :ref:`resolver <envoy_api_field_core.SocketAddress.resolver_name>`
   in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
   and will be resolved via DNS.
        .envoy.api.v2.core.Address address = 1;
        Specified by:
        hasAddress in interface EndpointOrBuilder
        Returns:
        Whether the address field is set.

      • getAddress

        public Address getAddress()
         The upstream host address.
 .. attention::
   The form of host address depends on the given cluster type. For STATIC or EDS,
   it is expected to be a direct IP address (or something resolvable by the
   specified :ref:`resolver <envoy_api_field_core.SocketAddress.resolver_name>`
   in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
   and will be resolved via DNS.
        .envoy.api.v2.core.Address address = 1;
        Specified by:
        getAddress in interface EndpointOrBuilder
        Returns:
        The address.

      • getAddressOrBuilder

        public AddressOrBuilder getAddressOrBuilder()
         The upstream host address.
 .. attention::
   The form of host address depends on the given cluster type. For STATIC or EDS,
   it is expected to be a direct IP address (or something resolvable by the
   specified :ref:`resolver <envoy_api_field_core.SocketAddress.resolver_name>`
   in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
   and will be resolved via DNS.
        .envoy.api.v2.core.Address address = 1;
        Specified by:
        getAddressOrBuilder in interface EndpointOrBuilder

      • hasHealthCheckConfig

        public boolean hasHealthCheckConfig()
         The optional health check configuration is used as configuration for the
 health checker to contact the health checked host.
 .. attention::
   This takes into effect only for upstream clusters with
   :ref:`active health checking <arch_overview_health_checking>` enabled.
        .envoy.api.v2.endpoint.Endpoint.HealthCheckConfig health_check_config = 2;
        Specified by:
        hasHealthCheckConfig in interface EndpointOrBuilder
        Returns:
        Whether the healthCheckConfig field is set.

      • getHealthCheckConfig

        public Endpoint.HealthCheckConfig getHealthCheckConfig()
         The optional health check configuration is used as configuration for the
 health checker to contact the health checked host.
 .. attention::
   This takes into effect only for upstream clusters with
   :ref:`active health checking <arch_overview_health_checking>` enabled.
        .envoy.api.v2.endpoint.Endpoint.HealthCheckConfig health_check_config = 2;
        Specified by:
        getHealthCheckConfig in interface EndpointOrBuilder
        Returns:
        The healthCheckConfig.

      • getHealthCheckConfigOrBuilder

        public Endpoint.HealthCheckConfigOrBuilder getHealthCheckConfigOrBuilder()
         The optional health check configuration is used as configuration for the
 health checker to contact the health checked host.
 .. attention::
   This takes into effect only for upstream clusters with
   :ref:`active health checking <arch_overview_health_checking>` enabled.
        .envoy.api.v2.endpoint.Endpoint.HealthCheckConfig health_check_config = 2;
        Specified by:
        getHealthCheckConfigOrBuilder in interface EndpointOrBuilder

      • getHostname

        public String getHostname()
         The hostname associated with this endpoint. This hostname is not used for routing or address
 resolution. If provided, it will be associated with the endpoint, and can be used for features
 that require a hostname, like
 :ref:`auto_host_rewrite <envoy_api_field_route.RouteAction.auto_host_rewrite>`.
        string hostname = 3;
        Specified by:
        getHostname in interface EndpointOrBuilder
        Returns:
        The hostname.

      • getHostnameBytes

        public com.google.protobuf.ByteString getHostnameBytes()
         The hostname associated with this endpoint. This hostname is not used for routing or address
 resolution. If provided, it will be associated with the endpoint, and can be used for features
 that require a hostname, like
 :ref:`auto_host_rewrite <envoy_api_field_route.RouteAction.auto_host_rewrite>`.
        string hostname = 3;
        Specified by:
        getHostnameBytes in interface EndpointOrBuilder
        Returns:
        The bytes for hostname.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Endpoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Endpoint getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Endpoint> 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.GeneratedMessageV3

      • getDefaultInstanceForType

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