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

Class Cluster.OriginalDstLbConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.cluster.v3.Cluster.OriginalDstLbConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cluster.OriginalDstLbConfigOrBuilder, Serializable
Enclosing class:
Cluster
public static final class Cluster.OriginalDstLbConfig extends com.google.protobuf.GeneratedMessage 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
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • USE_HTTP_HEADER_FIELD_NUMBER

      public static final int USE_HTTP_HEADER_FIELD_NUMBER
      See Also:

    • useHttpHeader_

      private boolean useHttpHeader_

    • HTTP_HEADER_NAME_FIELD_NUMBER

      public static final int HTTP_HEADER_NAME_FIELD_NUMBER
      See Also:

    • httpHeaderName_

      private volatile Object httpHeaderName_

    • UPSTREAM_PORT_OVERRIDE_FIELD_NUMBER

      public static final int UPSTREAM_PORT_OVERRIDE_FIELD_NUMBER
      See Also:

    • upstreamPortOverride_

      private com.google.protobuf.UInt32Value upstreamPortOverride_

    • METADATA_KEY_FIELD_NUMBER

      public static final int METADATA_KEY_FIELD_NUMBER
      See Also:

    • metadataKey_

      private MetadataKey metadataKey_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final Cluster.OriginalDstLbConfig DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<Cluster.OriginalDstLbConfig> PARSER

  • Constructor Details

    • OriginalDstLbConfig

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

    • OriginalDstLbConfig

      private OriginalDstLbConfig()

  • Method Details

    • 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

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

    • getHttpHeaderName

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

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

    • 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

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

    • getMetadataKeyOrBuilder

      public MetadataKeyOrBuilder getMetadataKeyOrBuilder()
       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:
      getMetadataKeyOrBuilder in interface Cluster.OriginalDstLbConfigOrBuilder

    • 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 Cluster.OriginalDstLbConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Cluster.OriginalDstLbConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Cluster.OriginalDstLbConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Cluster.OriginalDstLbConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Cluster.OriginalDstLbConfig.Builder newBuilder()

    • newBuilder

      public static Cluster.OriginalDstLbConfig.Builder newBuilder(Cluster.OriginalDstLbConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected Cluster.OriginalDstLbConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Cluster.OriginalDstLbConfig getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Cluster.OriginalDstLbConfig> 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 Cluster.OriginalDstLbConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder