Package io.envoyproxy.envoy.type.matcher.v3

Class StringMatcher.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<StringMatcher.Builder>
com.google.protobuf.GeneratedMessage.Builder<StringMatcher.Builder>
io.envoyproxy.envoy.type.matcher.v3.StringMatcher.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StringMatcherOrBuilder, Cloneable
Enclosing class:
StringMatcher
public static final class StringMatcher.Builder extends com.google.protobuf.GeneratedMessage.Builder<StringMatcher.Builder> implements StringMatcherOrBuilder
 Specifies the way to match a string.
 [#next-free-field: 9]
Protobuf type envoy.type.matcher.v3.StringMatcher

  • Field Details

  • Constructor Details

    • Builder

      private Builder()

    • Builder

      private Builder(com.google.protobuf.AbstractMessage.BuilderParent parent)

  • Method Details

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

    • clear

      public StringMatcher.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<StringMatcher.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<StringMatcher.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • buildPartial0

      private void buildPartial0(StringMatcher result)

    • buildPartialOneofs

      private void buildPartialOneofs(StringMatcher result)

    • mergeFrom

      public StringMatcher.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StringMatcher.Builder>

    • mergeFrom

      public StringMatcher.Builder mergeFrom(StringMatcher other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<StringMatcher.Builder>

    • mergeFrom

      public StringMatcher.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StringMatcher.Builder>
      Throws:
      IOException

    • getMatchPatternCase

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

    • clearMatchPattern

      public StringMatcher.Builder clearMatchPattern()

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

    • setExact

      public StringMatcher.Builder setExact(String value)
       The input string must match exactly the string specified here.

 Examples:

 * ``abc`` only matches the value ``abc``.
      string exact = 1;
      Parameters:
      value - The exact to set.
      Returns:
      This builder for chaining.

    • clearExact

      public StringMatcher.Builder clearExact()
       The input string must match exactly the string specified here.

 Examples:

 * ``abc`` only matches the value ``abc``.
      string exact = 1;
      Returns:
      This builder for chaining.

    • setExactBytes

      public StringMatcher.Builder setExactBytes(com.google.protobuf.ByteString value)
       The input string must match exactly the string specified here.

 Examples:

 * ``abc`` only matches the value ``abc``.
      string exact = 1;
      Parameters:
      value - The bytes for exact to set.
      Returns:
      This builder for chaining.

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

    • setPrefix

      public StringMatcher.Builder setPrefix(String value)
       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) = { ... }
      Parameters:
      value - The prefix to set.
      Returns:
      This builder for chaining.

    • clearPrefix

      public StringMatcher.Builder clearPrefix()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setPrefixBytes

      public StringMatcher.Builder setPrefixBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for prefix to set.
      Returns:
      This builder for chaining.

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

    • setSuffix

      public StringMatcher.Builder setSuffix(String value)
       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) = { ... }
      Parameters:
      value - The suffix to set.
      Returns:
      This builder for chaining.

    • clearSuffix

      public StringMatcher.Builder clearSuffix()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setSuffixBytes

      public StringMatcher.Builder setSuffixBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for suffix to set.
      Returns:
      This builder for chaining.

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

    • setSafeRegex

      public StringMatcher.Builder setSafeRegex(RegexMatcher value)
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

    • setSafeRegex

      public StringMatcher.Builder setSafeRegex(RegexMatcher.Builder builderForValue)
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

    • mergeSafeRegex

      public StringMatcher.Builder mergeSafeRegex(RegexMatcher value)
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

    • clearSafeRegex

      public StringMatcher.Builder clearSafeRegex()
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

    • getSafeRegexBuilder

      public RegexMatcher.Builder getSafeRegexBuilder()
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

    • getSafeRegexOrBuilder

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

    • getSafeRegexFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<RegexMatcher,RegexMatcher.Builder,RegexMatcherOrBuilder> getSafeRegexFieldBuilder()
       The input string must match the regular expression specified here.
      .envoy.type.matcher.v3.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

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

    • setContains

      public StringMatcher.Builder setContains(String value)
       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) = { ... }
      Parameters:
      value - The contains to set.
      Returns:
      This builder for chaining.

    • clearContains

      public StringMatcher.Builder clearContains()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setContainsBytes

      public StringMatcher.Builder setContainsBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for contains to set.
      Returns:
      This builder for chaining.

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

    • setCustom

      public StringMatcher.Builder setCustom(TypedExtensionConfig value)
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

    • setCustom

      public StringMatcher.Builder setCustom(TypedExtensionConfig.Builder builderForValue)
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

    • mergeCustom

      public StringMatcher.Builder mergeCustom(TypedExtensionConfig value)
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

    • clearCustom

      public StringMatcher.Builder clearCustom()
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

    • getCustomBuilder

      public TypedExtensionConfig.Builder getCustomBuilder()
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

    • 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

    • getCustomFieldBuilder

      private com.google.protobuf.SingleFieldBuilder<TypedExtensionConfig,TypedExtensionConfig.Builder,TypedExtensionConfigOrBuilder> getCustomFieldBuilder()
       Use an extension as the matcher type.
 [#extension-category: envoy.string_matcher]
      .xds.core.v3.TypedExtensionConfig custom = 8;

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

    • setIgnoreCase

      public StringMatcher.Builder setIgnoreCase(boolean value)
       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;
      Parameters:
      value - The ignoreCase to set.
      Returns:
      This builder for chaining.

    • clearIgnoreCase

      public StringMatcher.Builder clearIgnoreCase()
       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;
      Returns:
      This builder for chaining.