Interface EndpointOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Endpoint, Endpoint.Builder
@Generated public interface EndpointOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Endpoint.AdditionalAddress
    getAdditionalAddresses(int index)
    An ordered list of addresses that together with ``address`` comprise the list of addresses for an endpoint.
    int
    getAdditionalAddressesCount()
    An ordered list of addresses that together with ``address`` comprise the list of addresses for an endpoint.
    List<Endpoint.AdditionalAddress>
    getAdditionalAddressesList()
    An ordered list of addresses that together with ``address`` comprise the list of addresses for an endpoint.
    Endpoint.AdditionalAddressOrBuilder
    getAdditionalAddressesOrBuilder(int index)
    An ordered list of addresses that together with ``address`` comprise the list of addresses for an endpoint.
    List<? extends Endpoint.AdditionalAddressOrBuilder>
    getAdditionalAddressesOrBuilderList()
    An ordered list of addresses that together with ``address`` comprise the list of addresses for an endpoint.
    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.
    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.
    boolean
    hasAddress()
    The upstream host address. .. attention:: The form of host address depends on the given cluster type.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasAddress

      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;
      Returns:
      Whether the address field is set.

    • getAddress

      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;
      Returns:
      The address.

    • getAddressOrBuilder

      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;

    • hasHealthCheckConfig

      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;
      Returns:
      Whether the healthCheckConfig field is set.

    • getHealthCheckConfig

      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;
      Returns:
      The healthCheckConfig.

    • getHealthCheckConfigOrBuilder

      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;

    • getHostname

      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;
      Returns:
      The hostname.

    • getHostnameBytes

      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;
      Returns:
      The bytes for hostname.

    • getAdditionalAddressesList

      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;

    • getAdditionalAddresses

      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;

    • getAdditionalAddressesCount

      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;

    • getAdditionalAddressesOrBuilderList

      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;

    • getAdditionalAddressesOrBuilder

      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;