Package io.envoyproxy.envoy.extensions.filters.http.thrift_to_metadata.v3

Class Rule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Rule.Builder>
io.envoyproxy.envoy.extensions.filters.http.thrift_to_metadata.v3.Rule.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RuleOrBuilder, Cloneable
Enclosing class:
Rule
public static final class Rule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Rule.Builder> implements RuleOrBuilder
 [#next-free-field: 6]
Protobuf type envoy.extensions.filters.http.thrift_to_metadata.v3.Rule

  • Method Summary

    Modifier and Type
    Method
    Description
    Rule.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Rule
    build()
     
    Rule
    buildPartial()
     
    Rule.Builder
    clear()
     
    Rule.Builder
    clearField()
    The field to match on.
    Rule.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    Rule.Builder
    clearFieldSelector()
    Specifies that a match will be performed on the value of a field in the thrift body.
    Rule.Builder
    clearMethodName()
    If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>` will be used to extract the field value *only* on the thrift message with method name.
    Rule.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    Rule.Builder
    clearOnMissing()
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    Rule.Builder
    clearOnPresent()
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    Rule.Builder
    clone()
     
    Rule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    Field
    getField()
    The field to match on.
    FieldSelector
    getFieldSelector()
    Specifies that a match will be performed on the value of a field in the thrift body.
    FieldSelector.Builder
    getFieldSelectorBuilder()
    Specifies that a match will be performed on the value of a field in the thrift body.
    FieldSelectorOrBuilder
    getFieldSelectorOrBuilder()
    Specifies that a match will be performed on the value of a field in the thrift body.
    int
    getFieldValue()
    The field to match on.
    String
    getMethodName()
    If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>` will be used to extract the field value *only* on the thrift message with method name.
    com.google.protobuf.ByteString
    getMethodNameBytes()
    If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>` will be used to extract the field value *only* on the thrift message with method name.
    KeyValuePair
    getOnMissing()
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    KeyValuePair.Builder
    getOnMissingBuilder()
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    KeyValuePairOrBuilder
    getOnMissingOrBuilder()
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    KeyValuePair
    getOnPresent()
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    KeyValuePair.Builder
    getOnPresentBuilder()
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    KeyValuePairOrBuilder
    getOnPresentOrBuilder()
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    boolean
    hasFieldSelector()
    Specifies that a match will be performed on the value of a field in the thrift body.
    boolean
    hasOnMissing()
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    boolean
    hasOnPresent()
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Rule.Builder
    mergeFieldSelector(FieldSelector value)
    Specifies that a match will be performed on the value of a field in the thrift body.
    Rule.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Rule.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Rule.Builder
    mergeFrom(Rule other)
     
    Rule.Builder
    mergeOnMissing(KeyValuePair value)
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    Rule.Builder
    mergeOnPresent(KeyValuePair value)
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    final Rule.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    Rule.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Rule.Builder
    setField(Field value)
    The field to match on.
    Rule.Builder
    setFieldSelector(FieldSelector value)
    Specifies that a match will be performed on the value of a field in the thrift body.
    Rule.Builder
    setFieldSelector(FieldSelector.Builder builderForValue)
    Specifies that a match will be performed on the value of a field in the thrift body.
    Rule.Builder
    setFieldValue(int value)
    The field to match on.
    Rule.Builder
    setMethodName(String value)
    If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>` will be used to extract the field value *only* on the thrift message with method name.
    Rule.Builder
    setMethodNameBytes(com.google.protobuf.ByteString value)
    If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>` will be used to extract the field value *only* on the thrift message with method name.
    Rule.Builder
    setOnMissing(KeyValuePair value)
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    Rule.Builder
    setOnMissing(KeyValuePair.Builder builderForValue)
    The key-value pair to set in the *filter metadata* if the field is missing in *thrift metadata*.
    Rule.Builder
    setOnPresent(KeyValuePair value)
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    Rule.Builder
    setOnPresent(KeyValuePair.Builder builderForValue)
    The key-value pair to set in the *filter metadata* if the field is present in *thrift metadata*.
    Rule.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final Rule.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, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, 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 class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    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 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<Rule.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public Rule.Builder mergeFrom(Rule other)

    • isInitialized

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

    • mergeFrom

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

    • getFieldValue

      public int getFieldValue()
       The field to match on.
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 takes precedence if both are set.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.Field field = 1;
      Specified by:
      getFieldValue in interface RuleOrBuilder
      Returns:
      The enum numeric value on the wire for field.

    • setFieldValue

      public Rule.Builder setFieldValue(int value)
       The field to match on.
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 takes precedence if both are set.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.Field field = 1;
      Parameters:
      value - The enum numeric value on the wire for field to set.
      Returns:
      This builder for chaining.

    • getField

      public Field getField()
       The field to match on.
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 takes precedence if both are set.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.Field field = 1;
      Specified by:
      getField in interface RuleOrBuilder
      Returns:
      The field.

    • setField

      public Rule.Builder setField(Field value)
       The field to match on.
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 takes precedence if both are set.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.Field field = 1;
      Parameters:
      value - The field to set.
      Returns:
      This builder for chaining.

    • clearField

      public Rule.Builder clearField()
       The field to match on.
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 takes precedence if both are set.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.Field field = 1;
      Returns:
      This builder for chaining.

    • hasFieldSelector

      public boolean hasFieldSelector()
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;
      Specified by:
      hasFieldSelector in interface RuleOrBuilder
      Returns:
      Whether the fieldSelector field is set.

    • getFieldSelector

      public FieldSelector getFieldSelector()
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;
      Specified by:
      getFieldSelector in interface RuleOrBuilder
      Returns:
      The fieldSelector.

    • setFieldSelector

      public Rule.Builder setFieldSelector(FieldSelector value)
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;

    • setFieldSelector

      public Rule.Builder setFieldSelector(FieldSelector.Builder builderForValue)
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;

    • mergeFieldSelector

      public Rule.Builder mergeFieldSelector(FieldSelector value)
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;

    • clearFieldSelector

      public Rule.Builder clearFieldSelector()
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;

    • getFieldSelectorBuilder

      public FieldSelector.Builder getFieldSelectorBuilder()
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;

    • getFieldSelectorOrBuilder

      public FieldSelectorOrBuilder getFieldSelectorOrBuilder()
       Specifies that a match will be performed on the value of a field in the thrift body.
 If set, the whole http body will be buffered to extract the field value, which
 may have performance implications.

 It's a thrift over http version of
 :ref:`field_selector<envoy_v3_api_field_extensions.filters.network.thrift_proxy.filters.payload_to_metadata.v3.PayloadToMetadata.Rule.field_selector>`.

 See also `payload-to-metadata <https://www.envoyproxy.io/docs/envoy/latest/configuration/other_protocols/thrift_filters/payload_to_metadata_filter>`_
 for more reference.

 Example:

 .. code-block:: yaml

    method_name: foo
    field_selector:
      name: info
      id: 2
      child:
        name: version
        id: 1

 The above yaml will match on value of ``info.version`` in the below thrift schema as input of
 :ref:`on_present<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_present>` or
 :ref:`on_missing<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.on_missing>`
 while we are processing ``foo`` method. This rule won't be applied to ``bar`` method.

 .. code-block:: thrift

    struct Info {
      1: required string version;
    }
    service Server {
      bool foo(1: i32 id, 2: Info info);
      bool bar(1: i32 id, 2: Info info);
    }
      .envoy.extensions.filters.http.thrift_to_metadata.v3.FieldSelector field_selector = 2;
      Specified by:
      getFieldSelectorOrBuilder in interface RuleOrBuilder

    • getMethodName

      public String getMethodName()
       If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 will be used to extract the field value *only* on the thrift message with method name.
      string method_name = 3;
      Specified by:
      getMethodName in interface RuleOrBuilder
      Returns:
      The methodName.

    • getMethodNameBytes

      public com.google.protobuf.ByteString getMethodNameBytes()
       If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 will be used to extract the field value *only* on the thrift message with method name.
      string method_name = 3;
      Specified by:
      getMethodNameBytes in interface RuleOrBuilder
      Returns:
      The bytes for methodName.

    • setMethodName

      public Rule.Builder setMethodName(String value)
       If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 will be used to extract the field value *only* on the thrift message with method name.
      string method_name = 3;
      Parameters:
      value - The methodName to set.
      Returns:
      This builder for chaining.

    • clearMethodName

      public Rule.Builder clearMethodName()
       If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 will be used to extract the field value *only* on the thrift message with method name.
      string method_name = 3;
      Returns:
      This builder for chaining.

    • setMethodNameBytes

      public Rule.Builder setMethodNameBytes(com.google.protobuf.ByteString value)
       If specified, :ref:`field_selector<envoy_v3_api_field_extensions.filters.http.thrift_to_metadata.v3.Rule.field_selector>`
 will be used to extract the field value *only* on the thrift message with method name.
      string method_name = 3;
      Parameters:
      value - The bytes for methodName to set.
      Returns:
      This builder for chaining.

    • hasOnPresent

      public boolean hasOnPresent()
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;
      Specified by:
      hasOnPresent in interface RuleOrBuilder
      Returns:
      Whether the onPresent field is set.

    • getOnPresent

      public KeyValuePair getOnPresent()
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;
      Specified by:
      getOnPresent in interface RuleOrBuilder
      Returns:
      The onPresent.

    • setOnPresent

      public Rule.Builder setOnPresent(KeyValuePair value)
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;

    • setOnPresent

      public Rule.Builder setOnPresent(KeyValuePair.Builder builderForValue)
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;

    • mergeOnPresent

      public Rule.Builder mergeOnPresent(KeyValuePair value)
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;

    • clearOnPresent

      public Rule.Builder clearOnPresent()
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;

    • getOnPresentBuilder

      public KeyValuePair.Builder getOnPresentBuilder()
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;

    • getOnPresentOrBuilder

      public KeyValuePairOrBuilder getOnPresentOrBuilder()
       The key-value pair to set in the *filter metadata* if the field is present
 in *thrift metadata*.

 If the value in the KeyValuePair is non-empty, it'll be used instead
 of field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_present = 4;
      Specified by:
      getOnPresentOrBuilder in interface RuleOrBuilder

    • hasOnMissing

      public boolean hasOnMissing()
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;
      Specified by:
      hasOnMissing in interface RuleOrBuilder
      Returns:
      Whether the onMissing field is set.

    • getOnMissing

      public KeyValuePair getOnMissing()
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;
      Specified by:
      getOnMissing in interface RuleOrBuilder
      Returns:
      The onMissing.

    • setOnMissing

      public Rule.Builder setOnMissing(KeyValuePair value)
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;

    • setOnMissing

      public Rule.Builder setOnMissing(KeyValuePair.Builder builderForValue)
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;

    • mergeOnMissing

      public Rule.Builder mergeOnMissing(KeyValuePair value)
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;

    • clearOnMissing

      public Rule.Builder clearOnMissing()
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;

    • getOnMissingBuilder

      public KeyValuePair.Builder getOnMissingBuilder()
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;

    • getOnMissingOrBuilder

      public KeyValuePairOrBuilder getOnMissingOrBuilder()
       The key-value pair to set in the *filter metadata* if the field is missing
 in *thrift metadata*.

 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing field value.
      .envoy.extensions.filters.http.thrift_to_metadata.v3.KeyValuePair on_missing = 5;
      Specified by:
      getOnMissingOrBuilder in interface RuleOrBuilder

    • setUnknownFields

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

    • mergeUnknownFields

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