Package io.envoyproxy.envoy.extensions.clusters.reverse_connection.v3

Class ReverseConnectionClusterConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ReverseConnectionClusterConfig.Builder>
io.envoyproxy.envoy.extensions.clusters.reverse_connection.v3.ReverseConnectionClusterConfig.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ReverseConnectionClusterConfigOrBuilder, Cloneable
Enclosing class:
ReverseConnectionClusterConfig
public static final class ReverseConnectionClusterConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ReverseConnectionClusterConfig.Builder> implements ReverseConnectionClusterConfigOrBuilder
 Configuration for a cluster of type REVERSE_CONNECTION.
Protobuf type envoy.extensions.clusters.reverse_connection.v3.ReverseConnectionClusterConfig

  • Method Details

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public ReverseConnectionClusterConfig.Builder mergeFrom(ReverseConnectionClusterConfig other)

    • isInitialized

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

    • mergeFrom

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

    • hasCleanupInterval

      public boolean hasCleanupInterval()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      hasCleanupInterval in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      Whether the cleanupInterval field is set.

    • getCleanupInterval

      public com.google.protobuf.Duration getCleanupInterval()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      getCleanupInterval in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The cleanupInterval.

    • setCleanupInterval

      public ReverseConnectionClusterConfig.Builder setCleanupInterval(com.google.protobuf.Duration value)
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }

    • setCleanupInterval

      public ReverseConnectionClusterConfig.Builder setCleanupInterval(com.google.protobuf.Duration.Builder builderForValue)
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }

    • mergeCleanupInterval

      public ReverseConnectionClusterConfig.Builder mergeCleanupInterval(com.google.protobuf.Duration value)
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }

    • clearCleanupInterval

      public ReverseConnectionClusterConfig.Builder clearCleanupInterval()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }

    • getCleanupIntervalBuilder

      public com.google.protobuf.Duration.Builder getCleanupIntervalBuilder()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }

    • getCleanupIntervalOrBuilder

      public com.google.protobuf.DurationOrBuilder getCleanupIntervalOrBuilder()
       Time interval after which Envoy removes unused dynamic hosts created for reverse connections.
 Hosts that are not referenced by any connection pool are deleted during cleanup.

 If unset, Envoy uses a default of 60s.
      .google.protobuf.Duration cleanup_interval = 1 [(.validate.rules) = { ... }
      Specified by:
      getCleanupIntervalOrBuilder in interface ReverseConnectionClusterConfigOrBuilder

    • getHostIdFormat

      public String getHostIdFormat()
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getHostIdFormat in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The hostIdFormat.

    • getHostIdFormatBytes

      public com.google.protobuf.ByteString getHostIdFormatBytes()
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Specified by:
      getHostIdFormatBytes in interface ReverseConnectionClusterConfigOrBuilder
      Returns:
      The bytes for hostIdFormat.

    • setHostIdFormat

      public ReverseConnectionClusterConfig.Builder setHostIdFormat(String value)
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The hostIdFormat to set.
      Returns:
      This builder for chaining.

    • clearHostIdFormat

      public ReverseConnectionClusterConfig.Builder clearHostIdFormat()
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setHostIdFormatBytes

      public ReverseConnectionClusterConfig.Builder setHostIdFormatBytes(com.google.protobuf.ByteString value)
       Host identifier format string.

 This format string is evaluated against the downstream request context to compute
 the host identifier for selecting the reverse connection endpoint. The format string
 supports Envoy's standard formatter syntax, including:

 * ``%REQ(header-name)%``: Extract request header value.
 * ``%DYNAMIC_METADATA(namespace:key)%``: Extract dynamic metadata value.
 * ``%CEL(expression)%``: Evaluate CEL expression.
 * ``%DOWNSTREAM_REMOTE_ADDRESS%``: Downstream connection address.
 * ``%DOWNSTREAM_LOCAL_ADDRESS%``: Downstream local address.
 * Plain text and combinations of the above.

 Examples:

 * ``%REQ(x-remote-node-id)%``: Use the value of the ``x-remote-node-id`` header.
 * ``%REQ(host):EXTRACT_FIRST_PART%``: Extract the first part of the Host header before a dot.
 * ``%CEL(request.headers['x-node-id'] | orValue('default'))%``: Use CEL with fallback.
 * ``node-%REQ(x-tenant-id)%-%REQ(x-region)%``: Combine multiple values.

 If the format string evaluates to an empty value, the request will not be routed.
      string host_id_format = 2 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for hostIdFormat to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final ReverseConnectionClusterConfig.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<ReverseConnectionClusterConfig.Builder>

    • mergeUnknownFields

      public final ReverseConnectionClusterConfig.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<ReverseConnectionClusterConfig.Builder>