Package io.envoyproxy.envoy.config.cluster.v3

Class Cluster.OriginalDstLbConfig.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.OriginalDstLbConfigOrBuilder, java.lang.Cloneable
    Enclosing class:
    Cluster.OriginalDstLbConfig
    public static final class Cluster.OriginalDstLbConfig.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Cluster.OriginalDstLbConfig.Builder>
implements Cluster.OriginalDstLbConfigOrBuilder
     Specific configuration for the
 :ref:`Original Destination <arch_overview_load_balancing_types_original_destination>`
 load balancing policy.
 [#extension: envoy.clusters.original_dst]
    Protobuf type envoy.config.cluster.v3.Cluster.OriginalDstLbConfig

    • Field Detail

      • bitField0_

        private int bitField0_

      • useHttpHeader_

        private boolean useHttpHeader_

      • httpHeaderName_

        private java.lang.Object httpHeaderName_

      • upstreamPortOverride_

        private com.google.protobuf.UInt32Value upstreamPortOverride_

      • upstreamPortOverrideBuilder_

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,​com.google.protobuf.UInt32Value.Builder,​com.google.protobuf.UInt32ValueOrBuilder> upstreamPortOverrideBuilder_

    • Constructor Detail

      • Builder

        private Builder()

      • Builder

        private Builder​(com.google.protobuf.AbstractMessage.BuilderParent parent)

    • 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.Builder<Cluster.OriginalDstLbConfig.Builder>

      • maybeForceBuilderInitialization

        private void maybeForceBuilderInitialization()

      • 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.GeneratedMessage.Builder<Cluster.OriginalDstLbConfig.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

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

      • mergeFrom

        public Cluster.OriginalDstLbConfig.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws java.io.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<Cluster.OriginalDstLbConfig.Builder>
        Throws:
        java.io.IOException

      • getUseHttpHeader

        public boolean getUseHttpHeader()
         When true, a HTTP header can be used to override the original dst address. The default header is
 :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>`.

 .. attention::

 This header isn't sanitized by default, so enabling this feature allows HTTP clients to
 route traffic to arbitrary hosts and/or ports, which may have serious security
 consequences.

 .. note::

 If the header appears multiple times only the first value is used.
        bool use_http_header = 1;
        Specified by:
        getUseHttpHeader in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        The useHttpHeader.

      • setUseHttpHeader

        public Cluster.OriginalDstLbConfig.Builder setUseHttpHeader​(boolean value)
         When true, a HTTP header can be used to override the original dst address. The default header is
 :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>`.

 .. attention::

 This header isn't sanitized by default, so enabling this feature allows HTTP clients to
 route traffic to arbitrary hosts and/or ports, which may have serious security
 consequences.

 .. note::

 If the header appears multiple times only the first value is used.
        bool use_http_header = 1;
        Parameters:
        value - The useHttpHeader to set.
        Returns:
        This builder for chaining.

      • clearUseHttpHeader

        public Cluster.OriginalDstLbConfig.Builder clearUseHttpHeader()
         When true, a HTTP header can be used to override the original dst address. The default header is
 :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>`.

 .. attention::

 This header isn't sanitized by default, so enabling this feature allows HTTP clients to
 route traffic to arbitrary hosts and/or ports, which may have serious security
 consequences.

 .. note::

 If the header appears multiple times only the first value is used.
        bool use_http_header = 1;
        Returns:
        This builder for chaining.

      • getHttpHeaderName

        public java.lang.String getHttpHeaderName()
         The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
 is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
        string http_header_name = 2;
        Specified by:
        getHttpHeaderName in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        The httpHeaderName.

      • getHttpHeaderNameBytes

        public com.google.protobuf.ByteString getHttpHeaderNameBytes()
         The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
 is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
        string http_header_name = 2;
        Specified by:
        getHttpHeaderNameBytes in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        The bytes for httpHeaderName.

      • setHttpHeaderName

        public Cluster.OriginalDstLbConfig.Builder setHttpHeaderName​(java.lang.String value)
         The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
 is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
        string http_header_name = 2;
        Parameters:
        value - The httpHeaderName to set.
        Returns:
        This builder for chaining.

      • clearHttpHeaderName

        public Cluster.OriginalDstLbConfig.Builder clearHttpHeaderName()
         The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
 is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
        string http_header_name = 2;
        Returns:
        This builder for chaining.

      • setHttpHeaderNameBytes

        public Cluster.OriginalDstLbConfig.Builder setHttpHeaderNameBytes​(com.google.protobuf.ByteString value)
         The http header to override destination address if :ref:`use_http_header <envoy_v3_api_field_config.cluster.v3.Cluster.OriginalDstLbConfig.use_http_header>`.
 is set to true. If the value is empty, :ref:`x-envoy-original-dst-host <config_http_conn_man_headers_x-envoy-original-dst-host>` will be used.
        string http_header_name = 2;
        Parameters:
        value - The bytes for httpHeaderName to set.
        Returns:
        This builder for chaining.

      • hasUpstreamPortOverride

        public boolean hasUpstreamPortOverride()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }
        Specified by:
        hasUpstreamPortOverride in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        Whether the upstreamPortOverride field is set.

      • getUpstreamPortOverride

        public com.google.protobuf.UInt32Value getUpstreamPortOverride()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }
        Specified by:
        getUpstreamPortOverride in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        The upstreamPortOverride.

      • setUpstreamPortOverride

        public Cluster.OriginalDstLbConfig.Builder setUpstreamPortOverride​(com.google.protobuf.UInt32Value value)
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • setUpstreamPortOverride

        public Cluster.OriginalDstLbConfig.Builder setUpstreamPortOverride​(com.google.protobuf.UInt32Value.Builder builderForValue)
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • mergeUpstreamPortOverride

        public Cluster.OriginalDstLbConfig.Builder mergeUpstreamPortOverride​(com.google.protobuf.UInt32Value value)
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • clearUpstreamPortOverride

        public Cluster.OriginalDstLbConfig.Builder clearUpstreamPortOverride()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • getUpstreamPortOverrideBuilder

        public com.google.protobuf.UInt32Value.Builder getUpstreamPortOverrideBuilder()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • getUpstreamPortOverrideOrBuilder

        public com.google.protobuf.UInt32ValueOrBuilder getUpstreamPortOverrideOrBuilder()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }
        Specified by:
        getUpstreamPortOverrideOrBuilder in interface Cluster.OriginalDstLbConfigOrBuilder

      • getUpstreamPortOverrideFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<com.google.protobuf.UInt32Value,​com.google.protobuf.UInt32Value.Builder,​com.google.protobuf.UInt32ValueOrBuilder> getUpstreamPortOverrideFieldBuilder()
         The port to override for the original dst address. This port
 will take precedence over filter state and header override ports
        .google.protobuf.UInt32Value upstream_port_override = 3 [(.validate.rules) = { ... }

      • hasMetadataKey

        public boolean hasMetadataKey()
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;
        Specified by:
        hasMetadataKey in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        Whether the metadataKey field is set.

      • getMetadataKey

        public MetadataKey getMetadataKey()
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;
        Specified by:
        getMetadataKey in interface Cluster.OriginalDstLbConfigOrBuilder
        Returns:
        The metadataKey.

      • setMetadataKey

        public Cluster.OriginalDstLbConfig.Builder setMetadataKey​(MetadataKey value)
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;

      • setMetadataKey

        public Cluster.OriginalDstLbConfig.Builder setMetadataKey​(MetadataKey.Builder builderForValue)
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;

      • mergeMetadataKey

        public Cluster.OriginalDstLbConfig.Builder mergeMetadataKey​(MetadataKey value)
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;

      • clearMetadataKey

        public Cluster.OriginalDstLbConfig.Builder clearMetadataKey()
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;

      • getMetadataKeyBuilder

        public MetadataKey.Builder getMetadataKeyBuilder()
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;

      • getMetadataKeyFieldBuilder

        private com.google.protobuf.SingleFieldBuilder<MetadataKey,​MetadataKey.Builder,​MetadataKeyOrBuilder> getMetadataKeyFieldBuilder()
         The dynamic metadata key to override destination address.
 First the request metadata is considered, then the connection one.
        .envoy.type.metadata.v3.MetadataKey metadata_key = 4;