Package io.envoyproxy.envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3

Class HeaderToMetadata.Rule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HeaderToMetadata.RuleOrBuilder, java.io.Serializable
    Enclosing class:
    HeaderToMetadata
    public static final class HeaderToMetadata.Rule
extends com.google.protobuf.GeneratedMessageV3
implements HeaderToMetadata.RuleOrBuilder
     A Rule defines what metadata to apply when a header is present or missing.
    Protobuf type envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.Rule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HeaderToMetadata.Rule.Builder
      A Rule defines what metadata to apply when a header is present or missing.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int HEADER_FIELD_NUMBER  
      static int ON_MISSING_FIELD_NUMBER  
      static int ON_PRESENT_FIELD_NUMBER  
      static int REMOVE_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 Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getHeader

        public java.lang.String getHeader()
         Specifies that a match will be performed on the value of a header.
 The header to be extracted.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeader in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        The header.

      • getHeaderBytes

        public com.google.protobuf.ByteString getHeaderBytes()
         Specifies that a match will be performed on the value of a header.
 The header to be extracted.
        string header = 1 [(.validate.rules) = { ... }
        Specified by:
        getHeaderBytes in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        The bytes for header.

      • hasOnPresent

        public boolean hasOnPresent()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;
        Specified by:
        hasOnPresent in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        Whether the onPresent field is set.

      • getOnPresent

        public HeaderToMetadata.KeyValuePair getOnPresent()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;
        Specified by:
        getOnPresent in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        The onPresent.

      • getOnPresentOrBuilder

        public HeaderToMetadata.KeyValuePairOrBuilder getOnPresentOrBuilder()
         If the header is present, apply this metadata KeyValuePair.
 If the value in the KeyValuePair is non-empty, it'll be used instead
 of the header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_present = 2;
        Specified by:
        getOnPresentOrBuilder in interface HeaderToMetadata.RuleOrBuilder

      • hasOnMissing

        public boolean hasOnMissing()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;
        Specified by:
        hasOnMissing in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        Whether the onMissing field is set.

      • getOnMissing

        public HeaderToMetadata.KeyValuePair getOnMissing()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;
        Specified by:
        getOnMissing in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        The onMissing.

      • getOnMissingOrBuilder

        public HeaderToMetadata.KeyValuePairOrBuilder getOnMissingOrBuilder()
         If the header is not present, apply this metadata KeyValuePair.
 The value in the KeyValuePair must be set, since it'll be used in lieu
 of the missing header value.
        .envoy.extensions.filters.network.thrift_proxy.filters.header_to_metadata.v3.HeaderToMetadata.KeyValuePair on_missing = 3;
        Specified by:
        getOnMissingOrBuilder in interface HeaderToMetadata.RuleOrBuilder

      • getRemove

        public boolean getRemove()
         Whether or not to remove the header after a rule is applied.
 This prevents headers from leaking.
        bool remove = 4;
        Specified by:
        getRemove in interface HeaderToMetadata.RuleOrBuilder
        Returns:
        The remove.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 HeaderToMetadata.Rule parseFrom​(java.nio.ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static HeaderToMetadata.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 HeaderToMetadata.Rule parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static HeaderToMetadata.Rule parseFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static HeaderToMetadata.Rule parseDelimitedFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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