Class StringMatcher

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StringMatcherOrBuilder, java.io.Serializable

    public final class StringMatcher
    extends com.google.protobuf.GeneratedMessage
    implements StringMatcherOrBuilder
     Specifies the way to match a string.
     [#next-free-field: 9]
     
    Protobuf type envoy.type.matcher.v3.StringMatcher
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StringMatcher.Builder
      Specifies the way to match a string.
      static class  StringMatcher.MatchPatternCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private StringMatcher()  
      private StringMatcher​(com.google.protobuf.GeneratedMessage.Builder<?> builder)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getContains()
      The input string must have the substring specified here.
      com.google.protobuf.ByteString getContainsBytes()
      The input string must have the substring specified here.
      TypedExtensionConfig getCustom()
      Use an extension as the matcher type.
      TypedExtensionConfigOrBuilder getCustomOrBuilder()
      Use an extension as the matcher type.
      static StringMatcher getDefaultInstance()  
      StringMatcher getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getExact()
      The input string must match exactly the string specified here.
      com.google.protobuf.ByteString getExactBytes()
      The input string must match exactly the string specified here.
      boolean getIgnoreCase()
      If true, indicates the exact/prefix/suffix/contains matching should be case insensitive.
      StringMatcher.MatchPatternCase getMatchPatternCase()  
      com.google.protobuf.Parser<StringMatcher> getParserForType()  
      java.lang.String getPrefix()
      The input string must have the prefix specified here.
      com.google.protobuf.ByteString getPrefixBytes()
      The input string must have the prefix specified here.
      RegexMatcher getSafeRegex()
      The input string must match the regular expression specified here.
      RegexMatcherOrBuilder getSafeRegexOrBuilder()
      The input string must match the regular expression specified here.
      int getSerializedSize()  
      java.lang.String getSuffix()
      The input string must have the suffix specified here.
      com.google.protobuf.ByteString getSuffixBytes()
      The input string must have the suffix specified here.
      boolean hasContains()
      The input string must have the substring specified here.
      boolean hasCustom()
      Use an extension as the matcher type.
      boolean hasExact()
      The input string must match exactly the string specified here.
      int hashCode()  
      boolean hasPrefix()
      The input string must have the prefix specified here.
      boolean hasSafeRegex()
      The input string must match the regular expression specified here.
      boolean hasSuffix()
      The input string must have the suffix specified here.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static StringMatcher.Builder newBuilder()  
      static StringMatcher.Builder newBuilder​(StringMatcher prototype)  
      StringMatcher.Builder newBuilderForType()  
      protected StringMatcher.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static StringMatcher parseDelimitedFrom​(java.io.InputStream input)  
      static StringMatcher parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StringMatcher parseFrom​(byte[] data)  
      static StringMatcher parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StringMatcher parseFrom​(com.google.protobuf.ByteString data)  
      static StringMatcher parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StringMatcher parseFrom​(com.google.protobuf.CodedInputStream input)  
      static StringMatcher parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StringMatcher parseFrom​(java.io.InputStream input)  
      static StringMatcher parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static StringMatcher parseFrom​(java.nio.ByteBuffer data)  
      static StringMatcher parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<StringMatcher> parser()  
      StringMatcher.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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 Detail

      • matchPatternCase_

        private int matchPatternCase_
      • matchPattern_

        private java.lang.Object matchPattern_
      • SAFE_REGEX_FIELD_NUMBER

        public static final int SAFE_REGEX_FIELD_NUMBER
        See Also:
        Constant Field Values
      • IGNORE_CASE_FIELD_NUMBER

        public static final int IGNORE_CASE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ignoreCase_

        private boolean ignoreCase_
      • memoizedIsInitialized

        private byte memoizedIsInitialized
      • DEFAULT_INSTANCE

        private static final StringMatcher DEFAULT_INSTANCE
      • PARSER

        private static final com.google.protobuf.Parser<StringMatcher> PARSER
    • Constructor Detail

      • StringMatcher

        private StringMatcher​(com.google.protobuf.GeneratedMessage.Builder<?> builder)
      • StringMatcher

        private StringMatcher()
    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • hasExact

        public boolean hasExact()
         The input string must match exactly the string specified here.
        
         Examples:
        
         * ``abc`` only matches the value ``abc``.
         
        string exact = 1;
        Specified by:
        hasExact in interface StringMatcherOrBuilder
        Returns:
        Whether the exact field is set.
      • getExact

        public java.lang.String getExact()
         The input string must match exactly the string specified here.
        
         Examples:
        
         * ``abc`` only matches the value ``abc``.
         
        string exact = 1;
        Specified by:
        getExact in interface StringMatcherOrBuilder
        Returns:
        The exact.
      • getExactBytes

        public com.google.protobuf.ByteString getExactBytes()
         The input string must match exactly the string specified here.
        
         Examples:
        
         * ``abc`` only matches the value ``abc``.
         
        string exact = 1;
        Specified by:
        getExactBytes in interface StringMatcherOrBuilder
        Returns:
        The bytes for exact.
      • hasPrefix

        public boolean hasPrefix()
         The input string must have the prefix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``abc.xyz``
         
        string prefix = 2 [(.validate.rules) = { ... }
        Specified by:
        hasPrefix in interface StringMatcherOrBuilder
        Returns:
        Whether the prefix field is set.
      • getPrefix

        public java.lang.String getPrefix()
         The input string must have the prefix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``abc.xyz``
         
        string prefix = 2 [(.validate.rules) = { ... }
        Specified by:
        getPrefix in interface StringMatcherOrBuilder
        Returns:
        The prefix.
      • getPrefixBytes

        public com.google.protobuf.ByteString getPrefixBytes()
         The input string must have the prefix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``abc.xyz``
         
        string prefix = 2 [(.validate.rules) = { ... }
        Specified by:
        getPrefixBytes in interface StringMatcherOrBuilder
        Returns:
        The bytes for prefix.
      • hasSuffix

        public boolean hasSuffix()
         The input string must have the suffix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc``
         
        string suffix = 3 [(.validate.rules) = { ... }
        Specified by:
        hasSuffix in interface StringMatcherOrBuilder
        Returns:
        Whether the suffix field is set.
      • getSuffix

        public java.lang.String getSuffix()
         The input string must have the suffix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc``
         
        string suffix = 3 [(.validate.rules) = { ... }
        Specified by:
        getSuffix in interface StringMatcherOrBuilder
        Returns:
        The suffix.
      • getSuffixBytes

        public com.google.protobuf.ByteString getSuffixBytes()
         The input string must have the suffix specified here.
         Note: empty prefix is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc``
         
        string suffix = 3 [(.validate.rules) = { ... }
        Specified by:
        getSuffixBytes in interface StringMatcherOrBuilder
        Returns:
        The bytes for suffix.
      • hasSafeRegex

        public boolean hasSafeRegex()
         The input string must match the regular expression specified here.
         
        .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
        Specified by:
        hasSafeRegex in interface StringMatcherOrBuilder
        Returns:
        Whether the safeRegex field is set.
      • getSafeRegex

        public RegexMatcher getSafeRegex()
         The input string must match the regular expression specified here.
         
        .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
        Specified by:
        getSafeRegex in interface StringMatcherOrBuilder
        Returns:
        The safeRegex.
      • hasContains

        public boolean hasContains()
         The input string must have the substring specified here.
         Note: empty contains match is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc.def``
         
        string contains = 7 [(.validate.rules) = { ... }
        Specified by:
        hasContains in interface StringMatcherOrBuilder
        Returns:
        Whether the contains field is set.
      • getContains

        public java.lang.String getContains()
         The input string must have the substring specified here.
         Note: empty contains match is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc.def``
         
        string contains = 7 [(.validate.rules) = { ... }
        Specified by:
        getContains in interface StringMatcherOrBuilder
        Returns:
        The contains.
      • getContainsBytes

        public com.google.protobuf.ByteString getContainsBytes()
         The input string must have the substring specified here.
         Note: empty contains match is not allowed, please use regex instead.
        
         Examples:
        
         * ``abc`` matches the value ``xyz.abc.def``
         
        string contains = 7 [(.validate.rules) = { ... }
        Specified by:
        getContainsBytes in interface StringMatcherOrBuilder
        Returns:
        The bytes for contains.
      • hasCustom

        public boolean hasCustom()
         Use an extension as the matcher type.
         [#extension-category: envoy.string_matcher]
         
        .xds.core.v3.TypedExtensionConfig custom = 8;
        Specified by:
        hasCustom in interface StringMatcherOrBuilder
        Returns:
        Whether the custom field is set.
      • getCustom

        public TypedExtensionConfig getCustom()
         Use an extension as the matcher type.
         [#extension-category: envoy.string_matcher]
         
        .xds.core.v3.TypedExtensionConfig custom = 8;
        Specified by:
        getCustom in interface StringMatcherOrBuilder
        Returns:
        The custom.
      • getIgnoreCase

        public boolean getIgnoreCase()
         If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. This
         has no effect for the safe_regex match.
         For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
         
        bool ignore_case = 6;
        Specified by:
        getIgnoreCase in interface StringMatcherOrBuilder
        Returns:
        The ignoreCase.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • 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.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • 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 StringMatcher parseFrom​(java.nio.ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public static StringMatcher parseFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

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

        public static StringMatcher parseDelimitedFrom​(java.io.InputStream input)
                                                throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

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

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

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

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

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

        protected StringMatcher.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getDefaultInstance

        public static StringMatcher getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<StringMatcher> parser()
      • getParserForType

        public com.google.protobuf.Parser<StringMatcher> 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.GeneratedMessage
      • getDefaultInstanceForType

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