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

Class Endpoint

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.endpoint.v3.Endpoint
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EndpointOrBuilder, Serializable
@Generated public final class Endpoint extends com.google.protobuf.GeneratedMessage implements EndpointOrBuilder
 Upstream host identifier.
Protobuf type envoy.config.endpoint.v3.Endpoint
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • address_

      private Address address_

    • HEALTH_CHECK_CONFIG_FIELD_NUMBER

      public static final int HEALTH_CHECK_CONFIG_FIELD_NUMBER
      See Also:

    • healthCheckConfig_

      private Endpoint.HealthCheckConfig healthCheckConfig_

    • HOSTNAME_FIELD_NUMBER

      public static final int HOSTNAME_FIELD_NUMBER
      See Also:

    • hostname_

      private volatile Object hostname_

    • ADDITIONAL_ADDRESSES_FIELD_NUMBER

      public static final int ADDITIONAL_ADDRESSES_FIELD_NUMBER
      See Also:

    • additionalAddresses_

      private List<Endpoint.AdditionalAddress> additionalAddresses_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final Endpoint DEFAULT_INSTANCE

    • PARSER

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

  • Constructor Details

    • Endpoint

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

    • Endpoint

      private Endpoint()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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_v3_api_field_config.core.v3.SocketAddress.resolver_name>`
 in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
 and will be resolved via DNS.
      .envoy.config.core.v3.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_v3_api_field_config.core.v3.SocketAddress.resolver_name>`
 in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
 and will be resolved via DNS.
      .envoy.config.core.v3.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_v3_api_field_config.core.v3.SocketAddress.resolver_name>`
 in the Address). For LOGICAL or STRICT DNS, it is expected to be hostname,
 and will be resolved via DNS.
      .envoy.config.core.v3.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.config.endpoint.v3.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.config.endpoint.v3.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.config.endpoint.v3.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_v3_api_field_config.route.v3.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_v3_api_field_config.route.v3.RouteAction.auto_host_rewrite>`.
      string hostname = 3;
      Specified by:
      getHostnameBytes in interface EndpointOrBuilder
      Returns:
      The bytes for hostname.

    • getAdditionalAddressesList

      public List<Endpoint.AdditionalAddress> getAdditionalAddressesList()
       An ordered list of addresses that together with ``address`` comprise the
 list of addresses for an endpoint. The address given in the ``address`` is
 prepended to this list. It is assumed that the list must already be
 sorted by preference order of the addresses. This will only be supported
 for STATIC and EDS clusters.
      repeated .envoy.config.endpoint.v3.Endpoint.AdditionalAddress additional_addresses = 4;
      Specified by:
      getAdditionalAddressesList in interface EndpointOrBuilder

    • getAdditionalAddressesOrBuilderList

      public List<? extends Endpoint.AdditionalAddressOrBuilder> getAdditionalAddressesOrBuilderList()
       An ordered list of addresses that together with ``address`` comprise the
 list of addresses for an endpoint. The address given in the ``address`` is
 prepended to this list. It is assumed that the list must already be
 sorted by preference order of the addresses. This will only be supported
 for STATIC and EDS clusters.
      repeated .envoy.config.endpoint.v3.Endpoint.AdditionalAddress additional_addresses = 4;
      Specified by:
      getAdditionalAddressesOrBuilderList in interface EndpointOrBuilder

    • getAdditionalAddressesCount

      public int getAdditionalAddressesCount()
       An ordered list of addresses that together with ``address`` comprise the
 list of addresses for an endpoint. The address given in the ``address`` is
 prepended to this list. It is assumed that the list must already be
 sorted by preference order of the addresses. This will only be supported
 for STATIC and EDS clusters.
      repeated .envoy.config.endpoint.v3.Endpoint.AdditionalAddress additional_addresses = 4;
      Specified by:
      getAdditionalAddressesCount in interface EndpointOrBuilder

    • getAdditionalAddresses

      public Endpoint.AdditionalAddress getAdditionalAddresses(int index)
       An ordered list of addresses that together with ``address`` comprise the
 list of addresses for an endpoint. The address given in the ``address`` is
 prepended to this list. It is assumed that the list must already be
 sorted by preference order of the addresses. This will only be supported
 for STATIC and EDS clusters.
      repeated .envoy.config.endpoint.v3.Endpoint.AdditionalAddress additional_addresses = 4;
      Specified by:
      getAdditionalAddresses in interface EndpointOrBuilder

    • getAdditionalAddressesOrBuilder

      public Endpoint.AdditionalAddressOrBuilder getAdditionalAddressesOrBuilder(int index)
       An ordered list of addresses that together with ``address`` comprise the
 list of addresses for an endpoint. The address given in the ``address`` is
 prepended to this list. It is assumed that the list must already be
 sorted by preference order of the addresses. This will only be supported
 for STATIC and EDS clusters.
      repeated .envoy.config.endpoint.v3.Endpoint.AdditionalAddress additional_addresses = 4;
      Specified by:
      getAdditionalAddressesOrBuilder in interface EndpointOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Endpoint parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Endpoint parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Endpoint.Builder newBuilder()

    • newBuilder

      public static Endpoint.Builder newBuilder(Endpoint prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

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

    • getDefaultInstanceForType

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