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

Class Endpoint.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EndpointOrBuilder, Cloneable
    Enclosing class:
    Endpoint
    public static final class Endpoint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>
implements EndpointOrBuilder
     Upstream host identifier.
    Protobuf type envoy.config.endpoint.v3.Endpoint

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Endpoint.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      Endpoint build()  
      Endpoint buildPartial()  
      Endpoint.Builder clear()  
      Endpoint.Builder clearAddress()
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      Endpoint.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Endpoint.Builder clearHealthCheckConfig()
      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.Builder clearHostname()
      The hostname associated with this endpoint.
      Endpoint.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Endpoint.Builder clone()  
      Address getAddress()
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      Address.Builder getAddressBuilder()
      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 getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      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.HealthCheckConfig.Builder getHealthCheckConfigBuilder()
      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.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Endpoint.Builder mergeAddress​(Address value)
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      Endpoint.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Endpoint.Builder mergeFrom​(com.google.protobuf.Message other)  
      Endpoint.Builder mergeFrom​(Endpoint other)  
      Endpoint.Builder mergeHealthCheckConfig​(Endpoint.HealthCheckConfig value)
      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.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Endpoint.Builder setAddress​(Address value)
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      Endpoint.Builder setAddress​(Address.Builder builderForValue)
      The upstream host address. .. attention:: The form of host address depends on the given cluster type.
      Endpoint.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)  
      Endpoint.Builder setHealthCheckConfig​(Endpoint.HealthCheckConfig value)
      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.Builder setHealthCheckConfig​(Endpoint.HealthCheckConfig.Builder builderForValue)
      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.Builder setHostname​(String value)
      The hostname associated with this endpoint.
      Endpoint.Builder setHostnameBytes​(com.google.protobuf.ByteString value)
      The hostname associated with this endpoint.
      Endpoint.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)  
      Endpoint.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

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

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

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

        mergeFrom

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

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

    • Method Detail

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

      • clear

        public Endpoint.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.GeneratedMessageV3.Builder<Endpoint.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.GeneratedMessageV3.Builder<Endpoint.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Endpoint.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • setField

        public Endpoint.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • clearField

        public Endpoint.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • clearOneof

        public Endpoint.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • setRepeatedField

        public Endpoint.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • addRepeatedField

        public Endpoint.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • mergeFrom

        public Endpoint.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<Endpoint.Builder>

      • isInitialized

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

      • mergeFrom

        public Endpoint.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<Endpoint.Builder>
        Throws:
        IOException

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

      • setAddress

        public Endpoint.Builder setAddress​(Address value)
         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;

      • setAddress

        public Endpoint.Builder setAddress​(Address.Builder builderForValue)
         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;

      • mergeAddress

        public Endpoint.Builder mergeAddress​(Address value)
         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;

      • clearAddress

        public Endpoint.Builder clearAddress()
         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;

      • getAddressBuilder

        public Address.Builder getAddressBuilder()
         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;

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

      • setHealthCheckConfig

        public Endpoint.Builder setHealthCheckConfig​(Endpoint.HealthCheckConfig value)
         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;

      • setHealthCheckConfig

        public Endpoint.Builder setHealthCheckConfig​(Endpoint.HealthCheckConfig.Builder builderForValue)
         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;

      • mergeHealthCheckConfig

        public Endpoint.Builder mergeHealthCheckConfig​(Endpoint.HealthCheckConfig value)
         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;

      • clearHealthCheckConfig

        public Endpoint.Builder clearHealthCheckConfig()
         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;

      • getHealthCheckConfigBuilder

        public Endpoint.HealthCheckConfig.Builder getHealthCheckConfigBuilder()
         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;

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

      • setHostname

        public Endpoint.Builder setHostname​(String value)
         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;
        Parameters:
        value - The hostname to set.
        Returns:
        This builder for chaining.

      • clearHostname

        public Endpoint.Builder clearHostname()
         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:
        This builder for chaining.

      • setHostnameBytes

        public Endpoint.Builder setHostnameBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for hostname to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Endpoint.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>

      • mergeUnknownFields

        public final Endpoint.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Endpoint.Builder>