Package io.envoyproxy.envoy.type.matcher

Class RegexMatchAndSubstitute

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RegexMatchAndSubstituteOrBuilder, Serializable
    public final class RegexMatchAndSubstitute
extends com.google.protobuf.GeneratedMessageV3
implements RegexMatchAndSubstituteOrBuilder
     Describes how to match a string and then produce a new string using a regular
 expression and a substitution string.
    Protobuf type envoy.type.matcher.RegexMatchAndSubstitute
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  RegexMatchAndSubstitute.Builder
      Describes how to match a string and then produce a new string using a regular expression and a substitution string.

      • 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 PATTERN_FIELD_NUMBER  
      static int SUBSTITUTION_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 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

      • hasPattern

        public boolean hasPattern()
         The regular expression used to find portions of a string (hereafter called
 the "subject string") that should be replaced. When a new string is
 produced during the substitution operation, the new string is initially
 the same as the subject string, but then all matches in the subject string
 are replaced by the substitution string. If replacing all matches isn't
 desired, regular expression anchors can be used to ensure a single match,
 so as to replace just one occurrence of a pattern. Capture groups can be
 used in the pattern to extract portions of the subject string, and then
 referenced in the substitution string.
        .envoy.type.matcher.RegexMatcher pattern = 1;
        Specified by:
        hasPattern in interface RegexMatchAndSubstituteOrBuilder
        Returns:
        Whether the pattern field is set.

      • getPattern

        public RegexMatcher getPattern()
         The regular expression used to find portions of a string (hereafter called
 the "subject string") that should be replaced. When a new string is
 produced during the substitution operation, the new string is initially
 the same as the subject string, but then all matches in the subject string
 are replaced by the substitution string. If replacing all matches isn't
 desired, regular expression anchors can be used to ensure a single match,
 so as to replace just one occurrence of a pattern. Capture groups can be
 used in the pattern to extract portions of the subject string, and then
 referenced in the substitution string.
        .envoy.type.matcher.RegexMatcher pattern = 1;
        Specified by:
        getPattern in interface RegexMatchAndSubstituteOrBuilder
        Returns:
        The pattern.

      • getPatternOrBuilder

        public RegexMatcherOrBuilder getPatternOrBuilder()
         The regular expression used to find portions of a string (hereafter called
 the "subject string") that should be replaced. When a new string is
 produced during the substitution operation, the new string is initially
 the same as the subject string, but then all matches in the subject string
 are replaced by the substitution string. If replacing all matches isn't
 desired, regular expression anchors can be used to ensure a single match,
 so as to replace just one occurrence of a pattern. Capture groups can be
 used in the pattern to extract portions of the subject string, and then
 referenced in the substitution string.
        .envoy.type.matcher.RegexMatcher pattern = 1;
        Specified by:
        getPatternOrBuilder in interface RegexMatchAndSubstituteOrBuilder

      • getSubstitution

        public String getSubstitution()
         The string that should be substituted into matching portions of the
 subject string during a substitution operation to produce a new string.
 Capture groups in the pattern can be referenced in the substitution
 string. Note, however, that the syntax for referring to capture groups is
 defined by the chosen regular expression engine. Google's `RE2
 <https://github.com/google/re2>`_ regular expression engine uses a
 backslash followed by the capture group number to denote a numbered
 capture group. E.g., ``\1`` refers to capture group 1, and ``\2`` refers
 to capture group 2.
        string substitution = 2;
        Specified by:
        getSubstitution in interface RegexMatchAndSubstituteOrBuilder
        Returns:
        The substitution.

      • getSubstitutionBytes

        public com.google.protobuf.ByteString getSubstitutionBytes()
         The string that should be substituted into matching portions of the
 subject string during a substitution operation to produce a new string.
 Capture groups in the pattern can be referenced in the substitution
 string. Note, however, that the syntax for referring to capture groups is
 defined by the chosen regular expression engine. Google's `RE2
 <https://github.com/google/re2>`_ regular expression engine uses a
 backslash followed by the capture group number to denote a numbered
 capture group. E.g., ``\1`` refers to capture group 1, and ``\2`` refers
 to capture group 2.
        string substitution = 2;
        Specified by:
        getSubstitutionBytes in interface RegexMatchAndSubstituteOrBuilder
        Returns:
        The bytes for substitution.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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