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

Class Rule

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Rule.Builder
    [#next-free-field: 6]

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FIELD_FIELD_NUMBER
     
    static final int
    FIELD_SELECTOR_FIELD_NUMBER
     
    static final int
    METHOD_NAME_FIELD_NUMBER
     
    static final int
    ON_MISSING_FIELD_NUMBER
     
    static final int
    ON_PRESENT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Rule
    getDefaultInstance()
     
    Rule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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*.
    com.google.protobuf.Parser<Rule>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasFieldSelector()
    Specifies that a match will be performed on the value of a field in the thrift body.
    int
    hashCode()
     
    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()
     
    static Rule.Builder
    newBuilder()
     
    static Rule.Builder
    newBuilder(Rule prototype)
     
    Rule.Builder
    newBuilderForType()
     
    protected Rule.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Rule
    parseDelimitedFrom(InputStream input)
     
    static Rule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule
    parseFrom(byte[] data)
     
    static Rule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule
    parseFrom(com.google.protobuf.ByteString data)
     
    static Rule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Rule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule
    parseFrom(InputStream input)
     
    static Rule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Rule
    parseFrom(ByteBuffer data)
     
    static Rule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Rule>
    parser()
     
    Rule.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • FIELD_FIELD_NUMBER

      public static final int FIELD_FIELD_NUMBER
      See Also:

    • FIELD_SELECTOR_FIELD_NUMBER

      public static final int FIELD_SELECTOR_FIELD_NUMBER
      See Also:

    • METHOD_NAME_FIELD_NUMBER

      public static final int METHOD_NAME_FIELD_NUMBER
      See Also:

    • ON_PRESENT_FIELD_NUMBER

      public static final int ON_PRESENT_FIELD_NUMBER
      See Also:

    • ON_MISSING_FIELD_NUMBER

      public static final int ON_MISSING_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

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

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

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

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

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

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

    • 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

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Rule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Rule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Rule.Builder newBuilder()

    • newBuilder

      public static Rule.Builder newBuilder(Rule prototype)

    • toBuilder

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

    • newBuilderForType

      protected Rule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Rule getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Rule> 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.GeneratedMessageV3

    • getDefaultInstanceForType

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