StringMatcher.Builder (api 0.1.28 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>
    - - io.envoyproxy.envoy.type.matcher.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.GeneratedMessageV3.Builder<StringMatcher.Builder>
implements StringMatcherOrBuilder
```
```
 Specifies the way to match a string.
 [#next-free-field: 7]
 
```
Protobuf type envoy.type.matcher.StringMatcher

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`StringMatcher.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`StringMatcher`	`build()`
`StringMatcher`	`buildPartial()`
`StringMatcher.Builder`	`clear()`
`StringMatcher.Builder`	`clearExact()` The input string must match exactly the string specified here.
`StringMatcher.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`StringMatcher.Builder`	`clearIgnoreCase()` If true, indicates the exact/prefix/suffix matching should be case insensitive.
`StringMatcher.Builder`	`clearMatchPattern()`
`StringMatcher.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`StringMatcher.Builder`	`clearPrefix()` The input string must have the prefix specified here.
`StringMatcher.Builder`	`clearRegex()` Deprecated.
`StringMatcher.Builder`	`clearSafeRegex()` The input string must match the regular expression specified here.
`StringMatcher.Builder`	`clearSuffix()` The input string must have the suffix specified here.
`StringMatcher.Builder`	`clone()`
`StringMatcher`	`getDefaultInstanceForType()`
`static 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()`
`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.
`String`	`getRegex()` Deprecated.
`com.google.protobuf.ByteString`	`getRegexBytes()` Deprecated.
`RegexMatcher`	`getSafeRegex()` The input string must match the regular expression specified here.
`RegexMatcher.Builder`	`getSafeRegexBuilder()` The input string must match the regular expression specified here.
`RegexMatcherOrBuilder`	`getSafeRegexOrBuilder()` The input string must match the regular expression specified here.
`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`	`hasSafeRegex()` The input string must match the regular expression specified here.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`StringMatcher.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`StringMatcher.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`StringMatcher.Builder`	`mergeFrom(StringMatcher other)`
`StringMatcher.Builder`	`mergeSafeRegex(RegexMatcher value)` The input string must match the regular expression specified here.
`StringMatcher.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`StringMatcher.Builder`	`setExact(String value)` The input string must match exactly the string specified here.
`StringMatcher.Builder`	`setExactBytes(com.google.protobuf.ByteString value)` The input string must match exactly the string specified here.
`StringMatcher.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`StringMatcher.Builder`	`setIgnoreCase(boolean value)` If true, indicates the exact/prefix/suffix matching should be case insensitive.
`StringMatcher.Builder`	`setPrefix(String value)` The input string must have the prefix specified here.
`StringMatcher.Builder`	`setPrefixBytes(com.google.protobuf.ByteString value)` The input string must have the prefix specified here.
`StringMatcher.Builder`	`setRegex(String value)` Deprecated.
`StringMatcher.Builder`	`setRegexBytes(com.google.protobuf.ByteString value)` Deprecated.
`StringMatcher.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`StringMatcher.Builder`	`setSafeRegex(RegexMatcher.Builder builderForValue)` The input string must match the regular expression specified here.
`StringMatcher.Builder`	`setSafeRegex(RegexMatcher value)` The input string must match the regular expression specified here.
`StringMatcher.Builder`	`setSuffix(String value)` The input string must have the suffix specified here.
`StringMatcher.Builder`	`setSuffixBytes(com.google.protobuf.ByteString value)` The input string must have the suffix specified here.
`StringMatcher.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

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

clone
```
public StringMatcher.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

setField

public StringMatcher.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

clearField
```
public StringMatcher.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

clearOneof
```
public StringMatcher.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

setRepeatedField

public StringMatcher.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

addRepeatedField

public StringMatcher.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StringMatcher.Builder>

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.GeneratedMessageV3.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()

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

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

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;

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;

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;

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

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

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) = { ... }

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) = { ... }

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) = { ... }

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

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

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) = { ... }

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) = { ... }

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) = { ... }

getRegex

@Deprecated
public String getRegex()

Deprecated.

 The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.

string regex = 4 [deprecated = true, (.validate.rules) = { ... }

Specified by:: getRegex in interface StringMatcherOrBuilder

getRegexBytes

@Deprecated
public com.google.protobuf.ByteString getRegexBytes()

Deprecated.

 The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.

string regex = 4 [deprecated = true, (.validate.rules) = { ... }

Specified by:: getRegexBytes in interface StringMatcherOrBuilder

setRegex

@Deprecated
public StringMatcher.Builder setRegex(String value)

Deprecated.

 The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.

string regex = 4 [deprecated = true, (.validate.rules) = { ... }

clearRegex

@Deprecated
public StringMatcher.Builder clearRegex()

Deprecated.

 The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.

string regex = 4 [deprecated = true, (.validate.rules) = { ... }

setRegexBytes

@Deprecated
public StringMatcher.Builder setRegexBytes(com.google.protobuf.ByteString value)

Deprecated.

 The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.

string regex = 4 [deprecated = true, (.validate.rules) = { ... }

hasSafeRegex
```
public boolean hasSafeRegex()
```
```
 The input string must match the regular expression specified here.
 
```
.envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
Specified by:

hasSafeRegex in interface StringMatcherOrBuilder

getSafeRegex
```
public RegexMatcher getSafeRegex()
```
```
 The input string must match the regular expression specified here.
 
```
.envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
Specified by:

getSafeRegex in interface StringMatcherOrBuilder