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

Interface RuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Rule, Rule.Builder
public interface RuleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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*.
    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*.
    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*.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFieldValue

      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;
      Returns:
      The enum numeric value on the wire for field.

    • getField

      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;
      Returns:
      The field.

    • hasFieldSelector

      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;
      Returns:
      Whether the fieldSelector field is set.

    • getFieldSelector

      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;
      Returns:
      The fieldSelector.

    • getFieldSelectorOrBuilder

      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;

    • getMethodName

      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;
      Returns:
      The methodName.

    • getMethodNameBytes

      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;
      Returns:
      The bytes for methodName.

    • hasOnPresent

      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;
      Returns:
      Whether the onPresent field is set.

    • getOnPresent

      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;
      Returns:
      The onPresent.

    • getOnPresentOrBuilder

      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;

    • hasOnMissing

      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;
      Returns:
      Whether the onMissing field is set.

    • getOnMissing

      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;
      Returns:
      The onMissing.

    • getOnMissingOrBuilder

      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;