Package com.github.xds.type.matcher.v3

Class StringMatcher

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.github.xds.type.matcher.v3.StringMatcher
All Implemented Interfaces:
StringMatcherOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class StringMatcher extends com.google.protobuf.GeneratedMessage implements StringMatcherOrBuilder
 Specifies the way to match a string.
 [#next-free-field: 9]
Protobuf type xds.type.matcher.v3.StringMatcher
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    StringMatcher.Builder
    Specifies the way to match a string.
    static enum 
    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>, 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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTAINS_FIELD_NUMBER
     
    static final int
    CUSTOM_FIELD_NUMBER
     
    private static final StringMatcher
    DEFAULT_INSTANCE
     
    static final int
    EXACT_FIELD_NUMBER
     
    static final int
    IGNORE_CASE_FIELD_NUMBER
     
    private boolean
    ignoreCase_
     
    private Object
    matchPattern_
     
    private int
    matchPatternCase_
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<StringMatcher>
    PARSER
     
    static final int
    PREFIX_FIELD_NUMBER
     
    static final int
    SAFE_REGEX_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     
    static final int
    SUFFIX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    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 final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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 matching should be case insensitive.
    StringMatcher.MatchPatternCase
    getMatchPatternCase()
     
    com.google.protobuf.Parser<StringMatcher>
    getParserForType()
     
    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()
     
    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()
     
    final 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(InputStream input)
     
    static StringMatcher
    parseDelimitedFrom(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(InputStream input)
     
    static StringMatcher
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static StringMatcher
    parseFrom(ByteBuffer data)
     
    static StringMatcher
    parseFrom(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

    computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • matchPatternCase_

      private int matchPatternCase_

    • matchPattern_

      private Object matchPattern_

    • EXACT_FIELD_NUMBER

      public static final int EXACT_FIELD_NUMBER
      See Also:

    • PREFIX_FIELD_NUMBER

      public static final int PREFIX_FIELD_NUMBER
      See Also:

    • SUFFIX_FIELD_NUMBER

      public static final int SUFFIX_FIELD_NUMBER
      See Also:

    • SAFE_REGEX_FIELD_NUMBER

      public static final int SAFE_REGEX_FIELD_NUMBER
      See Also:

    • CONTAINS_FIELD_NUMBER

      public static final int CONTAINS_FIELD_NUMBER
      See Also:

    • CUSTOM_FIELD_NUMBER

      public static final int CUSTOM_FIELD_NUMBER
      See Also:

    • IGNORE_CASE_FIELD_NUMBER

      public static final int IGNORE_CASE_FIELD_NUMBER
      See Also:

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

    • StringMatcher

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

    • StringMatcher

      private StringMatcher()

  • Method Details

    • getDescriptor

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getMatchPatternCase

      public StringMatcher.MatchPatternCase getMatchPatternCase()
      Specified by:
      getMatchPatternCase in interface StringMatcherOrBuilder

    • 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 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 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 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.
      .xds.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.
      .xds.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
      Specified by:
      getSafeRegex in interface StringMatcherOrBuilder
      Returns:
      The safeRegex.

    • getSafeRegexOrBuilder

      public RegexMatcherOrBuilder getSafeRegexOrBuilder()
       The input string must match the regular expression specified here.
      .xds.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
      Specified by:
      getSafeRegexOrBuilder in interface StringMatcherOrBuilder

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

    • getCustomOrBuilder

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

    • getIgnoreCase

      public boolean getIgnoreCase()
       If true, indicates the exact/prefix/suffix 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StringMatcher parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StringMatcher.Builder newBuilder()

    • newBuilder

      public static StringMatcher.Builder newBuilder(StringMatcher prototype)

    • 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