public final class StringRules extends com.google.protobuf.GeneratedMessageV3 implements StringRulesOrBuilder
StringRules describes the constraints applied to `string` values These rules may also be applied to the `google.protobuf.StringValue` Well-Known-Type.Protobuf type
buf.validate.StringRules| Modifier and Type | Class and Description |
|---|---|
static class |
StringRules.Builder
StringRules describes the constraints applied to `string` values These
rules may also be applied to the `google.protobuf.StringValue` Well-Known-Type.
|
static class |
StringRules.WellKnownCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
getAddress()
`address` specifies that the field value must be either a valid hostname
as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5)
(which doesn't support internationalized domain names or IDNs) or a valid
IP (v4 or v6).
|
String |
getConst()
`const` requires the field value to exactly match the specified value.
|
com.google.protobuf.ByteString |
getConstBytes()
`const` requires the field value to exactly match the specified value.
|
String |
getContains()
`contains` specifies that the field value must have the
specified substring anywhere in the string.
|
com.google.protobuf.ByteString |
getContainsBytes()
`contains` specifies that the field value must have the
specified substring anywhere in the string.
|
static StringRules |
getDefaultInstance() |
StringRules |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getEmail()
`email` specifies that the field value must be a valid email address
(addr-spec only) as defined by [RFC 5322](https://tools.ietf.org/html/rfc5322#section-3.4.1).
|
boolean |
getHostname()
`hostname` specifies that the field value must be a valid
hostname as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5).
|
String |
getIn(int index)
`in` specifies that the field value must be equal to one of the specified
values.
|
com.google.protobuf.ByteString |
getInBytes(int index)
`in` specifies that the field value must be equal to one of the specified
values.
|
int |
getInCount()
`in` specifies that the field value must be equal to one of the specified
values.
|
com.google.protobuf.ProtocolStringList |
getInList()
`in` specifies that the field value must be equal to one of the specified
values.
|
boolean |
getIp()
`ip` specifies that the field value must be a valid IP
(v4 or v6) address, without surrounding square brackets for IPv6 addresses.
|
boolean |
getIpPrefix()
`ip_prefix` specifies that the field value must be a valid IP (v4 or v6) prefix.
|
boolean |
getIpv4()
`ipv4` specifies that the field value must be a valid IPv4
address.
|
boolean |
getIpv4Prefix()
`ipv4_prefix` specifies that the field value must be a valid IPv4
prefix.
|
boolean |
getIpv4WithPrefixlen()
`ipv4_with_prefixlen` specifies that the field value must be a valid
IPv4 address with prefix.
|
boolean |
getIpv6()
`ipv6` specifies that the field value must be a valid
IPv6 address, without surrounding square brackets.
|
boolean |
getIpv6Prefix()
`ipv6_prefix` specifies that the field value must be a valid IPv6 prefix.
|
boolean |
getIpv6WithPrefixlen()
`ipv6_with_prefixlen` specifies that the field value must be a valid
IPv6 address with prefix length.
|
boolean |
getIpWithPrefixlen()
`ip_with_prefixlen` specifies that the field value must be a valid IP (v4 or v6)
address with prefix length.
|
long |
getLen()
`len` dictates that the field value must have the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string.
|
long |
getLenBytes()
`len_bytes` dictates that the field value must have the specified number of
bytes.
|
long |
getMaxBytes()
`max_bytes` specifies that the field value must have no more than the
specified number of bytes.
|
long |
getMaxLen()
`max_len` specifies that the field value must have no more than the specified
number of characters (Unicode code points), which may differ from the
number of bytes in the string.
|
long |
getMinBytes()
`min_bytes` specifies that the field value must have at least the specified
number of bytes.
|
long |
getMinLen()
`min_len` specifies that the field value must have at least the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string.
|
String |
getNotContains()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string.
|
com.google.protobuf.ByteString |
getNotContainsBytes()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string.
|
String |
getNotIn(int index)
`not_in` specifies that the field value cannot be equal to any
of the specified values.
|
com.google.protobuf.ByteString |
getNotInBytes(int index)
`not_in` specifies that the field value cannot be equal to any
of the specified values.
|
int |
getNotInCount()
`not_in` specifies that the field value cannot be equal to any
of the specified values.
|
com.google.protobuf.ProtocolStringList |
getNotInList()
`not_in` specifies that the field value cannot be equal to any
of the specified values.
|
com.google.protobuf.Parser<StringRules> |
getParserForType() |
String |
getPattern()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters.
|
com.google.protobuf.ByteString |
getPatternBytes()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters.
|
String |
getPrefix()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string.
|
com.google.protobuf.ByteString |
getPrefixBytes()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string.
|
boolean |
getStrict()
This applies to regexes `HTTP_HEADER_NAME` and `HTTP_HEADER_VALUE` to
enable strict header validation.
|
String |
getSuffix()
`suffix` specifies that the field value must have the
specified substring at the end of the string.
|
com.google.protobuf.ByteString |
getSuffixBytes()
`suffix` specifies that the field value must have the
specified substring at the end of the string.
|
boolean |
getUri()
`uri` specifies that the field value must be a valid,
absolute URI as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3).
|
boolean |
getUriRef()
`uri_ref` specifies that the field value must be a valid URI
as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) and may be either relative or absolute.
|
boolean |
getUuid()
`uuid` specifies that the field value must be a valid UUID as defined by
[RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.2).
|
StringRules.WellKnownCase |
getWellKnownCase() |
KnownRegex |
getWellKnownRegex()
`well_known_regex` specifies a common well-known pattern
defined as a regex.
|
int |
getWellKnownRegexValue()
`well_known_regex` specifies a common well-known pattern
defined as a regex.
|
boolean |
hasAddress()
`address` specifies that the field value must be either a valid hostname
as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5)
(which doesn't support internationalized domain names or IDNs) or a valid
IP (v4 or v6).
|
boolean |
hasConst()
`const` requires the field value to exactly match the specified value.
|
boolean |
hasContains()
`contains` specifies that the field value must have the
specified substring anywhere in the string.
|
boolean |
hasEmail()
`email` specifies that the field value must be a valid email address
(addr-spec only) as defined by [RFC 5322](https://tools.ietf.org/html/rfc5322#section-3.4.1).
|
boolean |
hasHostname()
`hostname` specifies that the field value must be a valid
hostname as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5).
|
boolean |
hasIp()
`ip` specifies that the field value must be a valid IP
(v4 or v6) address, without surrounding square brackets for IPv6 addresses.
|
boolean |
hasIpPrefix()
`ip_prefix` specifies that the field value must be a valid IP (v4 or v6) prefix.
|
boolean |
hasIpv4()
`ipv4` specifies that the field value must be a valid IPv4
address.
|
boolean |
hasIpv4Prefix()
`ipv4_prefix` specifies that the field value must be a valid IPv4
prefix.
|
boolean |
hasIpv4WithPrefixlen()
`ipv4_with_prefixlen` specifies that the field value must be a valid
IPv4 address with prefix.
|
boolean |
hasIpv6()
`ipv6` specifies that the field value must be a valid
IPv6 address, without surrounding square brackets.
|
boolean |
hasIpv6Prefix()
`ipv6_prefix` specifies that the field value must be a valid IPv6 prefix.
|
boolean |
hasIpv6WithPrefixlen()
`ipv6_with_prefixlen` specifies that the field value must be a valid
IPv6 address with prefix length.
|
boolean |
hasIpWithPrefixlen()
`ip_with_prefixlen` specifies that the field value must be a valid IP (v4 or v6)
address with prefix length.
|
boolean |
hasLen()
`len` dictates that the field value must have the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string.
|
boolean |
hasLenBytes()
`len_bytes` dictates that the field value must have the specified number of
bytes.
|
boolean |
hasMaxBytes()
`max_bytes` specifies that the field value must have no more than the
specified number of bytes.
|
boolean |
hasMaxLen()
`max_len` specifies that the field value must have no more than the specified
number of characters (Unicode code points), which may differ from the
number of bytes in the string.
|
boolean |
hasMinBytes()
`min_bytes` specifies that the field value must have at least the specified
number of bytes.
|
boolean |
hasMinLen()
`min_len` specifies that the field value must have at least the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string.
|
boolean |
hasNotContains()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string.
|
boolean |
hasPattern()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters.
|
boolean |
hasPrefix()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string.
|
boolean |
hasStrict()
This applies to regexes `HTTP_HEADER_NAME` and `HTTP_HEADER_VALUE` to
enable strict header validation.
|
boolean |
hasSuffix()
`suffix` specifies that the field value must have the
specified substring at the end of the string.
|
boolean |
hasUri()
`uri` specifies that the field value must be a valid,
absolute URI as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3).
|
boolean |
hasUriRef()
`uri_ref` specifies that the field value must be a valid URI
as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) and may be either relative or absolute.
|
boolean |
hasUuid()
`uuid` specifies that the field value must be a valid UUID as defined by
[RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.2).
|
boolean |
hasWellKnownRegex()
`well_known_regex` specifies a common well-known pattern
defined as a regex.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
static StringRules.Builder |
newBuilder() |
static StringRules.Builder |
newBuilder(StringRules prototype) |
StringRules.Builder |
newBuilderForType() |
protected StringRules.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static StringRules |
parseDelimitedFrom(InputStream input) |
static StringRules |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StringRules |
parseFrom(byte[] data) |
static StringRules |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StringRules |
parseFrom(ByteBuffer data) |
static StringRules |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StringRules |
parseFrom(com.google.protobuf.ByteString data) |
static StringRules |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StringRules |
parseFrom(com.google.protobuf.CodedInputStream input) |
static StringRules |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static StringRules |
parseFrom(InputStream input) |
static StringRules |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<StringRules> |
parser() |
StringRules.Builder |
toBuilder() |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getSerializedSize, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isInitialized, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag, writeToequals, findInitializationErrors, getInitializationErrorString, hashBoolean, hashCode, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int CONST_FIELD_NUMBER
public static final int LEN_FIELD_NUMBER
public static final int MIN_LEN_FIELD_NUMBER
public static final int MAX_LEN_FIELD_NUMBER
public static final int LEN_BYTES_FIELD_NUMBER
public static final int MIN_BYTES_FIELD_NUMBER
public static final int MAX_BYTES_FIELD_NUMBER
public static final int PATTERN_FIELD_NUMBER
public static final int PREFIX_FIELD_NUMBER
public static final int SUFFIX_FIELD_NUMBER
public static final int CONTAINS_FIELD_NUMBER
public static final int NOT_CONTAINS_FIELD_NUMBER
public static final int IN_FIELD_NUMBER
public static final int NOT_IN_FIELD_NUMBER
public static final int EMAIL_FIELD_NUMBER
public static final int HOSTNAME_FIELD_NUMBER
public static final int IP_FIELD_NUMBER
public static final int IPV4_FIELD_NUMBER
public static final int IPV6_FIELD_NUMBER
public static final int URI_FIELD_NUMBER
public static final int URI_REF_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
public static final int UUID_FIELD_NUMBER
public static final int IP_WITH_PREFIXLEN_FIELD_NUMBER
public static final int IPV4_WITH_PREFIXLEN_FIELD_NUMBER
public static final int IPV6_WITH_PREFIXLEN_FIELD_NUMBER
public static final int IP_PREFIX_FIELD_NUMBER
public static final int IPV4_PREFIX_FIELD_NUMBER
public static final int IPV6_PREFIX_FIELD_NUMBER
public static final int WELL_KNOWN_REGEX_FIELD_NUMBER
public static final int STRICT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public StringRules.WellKnownCase getWellKnownCase()
getWellKnownCase in interface StringRulesOrBuilderpublic boolean hasConst()
`const` requires the field value to exactly match the specified value. If
the field value doesn't match, an error message is generated.
```proto
message MyString {
// value must equal `hello`
string value = 1 [(buf.validate.field).string.const = "hello"];
}
```
optional string const = 1 [json_name = "const", (.buf.validate.priv.field) = { ... }hasConst in interface StringRulesOrBuilderpublic String getConst()
`const` requires the field value to exactly match the specified value. If
the field value doesn't match, an error message is generated.
```proto
message MyString {
// value must equal `hello`
string value = 1 [(buf.validate.field).string.const = "hello"];
}
```
optional string const = 1 [json_name = "const", (.buf.validate.priv.field) = { ... }getConst in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getConstBytes()
`const` requires the field value to exactly match the specified value. If
the field value doesn't match, an error message is generated.
```proto
message MyString {
// value must equal `hello`
string value = 1 [(buf.validate.field).string.const = "hello"];
}
```
optional string const = 1 [json_name = "const", (.buf.validate.priv.field) = { ... }getConstBytes in interface StringRulesOrBuilderpublic boolean hasLen()
`len` dictates that the field value must have the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string. If the field value does not meet the specified
length, an error message will be generated.
```proto
message MyString {
// value length must be 5 characters
string value = 1 [(buf.validate.field).string.len = 5];
}
```
optional uint64 len = 19 [json_name = "len", (.buf.validate.priv.field) = { ... }hasLen in interface StringRulesOrBuilderpublic long getLen()
`len` dictates that the field value must have the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string. If the field value does not meet the specified
length, an error message will be generated.
```proto
message MyString {
// value length must be 5 characters
string value = 1 [(buf.validate.field).string.len = 5];
}
```
optional uint64 len = 19 [json_name = "len", (.buf.validate.priv.field) = { ... }getLen in interface StringRulesOrBuilderpublic boolean hasMinLen()
`min_len` specifies that the field value must have at least the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string. If the field value contains fewer characters, an error
message will be generated.
```proto
message MyString {
// value length must be at least 3 characters
string value = 1 [(buf.validate.field).string.min_len = 3];
}
```
optional uint64 min_len = 2 [json_name = "minLen", (.buf.validate.priv.field) = { ... }hasMinLen in interface StringRulesOrBuilderpublic long getMinLen()
`min_len` specifies that the field value must have at least the specified
number of characters (Unicode code points), which may differ from the number
of bytes in the string. If the field value contains fewer characters, an error
message will be generated.
```proto
message MyString {
// value length must be at least 3 characters
string value = 1 [(buf.validate.field).string.min_len = 3];
}
```
optional uint64 min_len = 2 [json_name = "minLen", (.buf.validate.priv.field) = { ... }getMinLen in interface StringRulesOrBuilderpublic boolean hasMaxLen()
`max_len` specifies that the field value must have no more than the specified
number of characters (Unicode code points), which may differ from the
number of bytes in the string. If the field value contains more characters,
an error message will be generated.
```proto
message MyString {
// value length must be at most 10 characters
string value = 1 [(buf.validate.field).string.max_len = 10];
}
```
optional uint64 max_len = 3 [json_name = "maxLen", (.buf.validate.priv.field) = { ... }hasMaxLen in interface StringRulesOrBuilderpublic long getMaxLen()
`max_len` specifies that the field value must have no more than the specified
number of characters (Unicode code points), which may differ from the
number of bytes in the string. If the field value contains more characters,
an error message will be generated.
```proto
message MyString {
// value length must be at most 10 characters
string value = 1 [(buf.validate.field).string.max_len = 10];
}
```
optional uint64 max_len = 3 [json_name = "maxLen", (.buf.validate.priv.field) = { ... }getMaxLen in interface StringRulesOrBuilderpublic boolean hasLenBytes()
`len_bytes` dictates that the field value must have the specified number of
bytes. If the field value does not match the specified length in bytes,
an error message will be generated.
```proto
message MyString {
// value length must be 6 bytes
string value = 1 [(buf.validate.field).string.len_bytes = 6];
}
```
optional uint64 len_bytes = 20 [json_name = "lenBytes", (.buf.validate.priv.field) = { ... }hasLenBytes in interface StringRulesOrBuilderpublic long getLenBytes()
`len_bytes` dictates that the field value must have the specified number of
bytes. If the field value does not match the specified length in bytes,
an error message will be generated.
```proto
message MyString {
// value length must be 6 bytes
string value = 1 [(buf.validate.field).string.len_bytes = 6];
}
```
optional uint64 len_bytes = 20 [json_name = "lenBytes", (.buf.validate.priv.field) = { ... }getLenBytes in interface StringRulesOrBuilderpublic boolean hasMinBytes()
`min_bytes` specifies that the field value must have at least the specified
number of bytes. If the field value contains fewer bytes, an error message
will be generated.
```proto
message MyString {
// value length must be at least 4 bytes
string value = 1 [(buf.validate.field).string.min_bytes = 4];
}
```
optional uint64 min_bytes = 4 [json_name = "minBytes", (.buf.validate.priv.field) = { ... }hasMinBytes in interface StringRulesOrBuilderpublic long getMinBytes()
`min_bytes` specifies that the field value must have at least the specified
number of bytes. If the field value contains fewer bytes, an error message
will be generated.
```proto
message MyString {
// value length must be at least 4 bytes
string value = 1 [(buf.validate.field).string.min_bytes = 4];
}
```
optional uint64 min_bytes = 4 [json_name = "minBytes", (.buf.validate.priv.field) = { ... }getMinBytes in interface StringRulesOrBuilderpublic boolean hasMaxBytes()
`max_bytes` specifies that the field value must have no more than the
specified number of bytes. If the field value contains more bytes, an
error message will be generated.
```proto
message MyString {
// value length must be at most 8 bytes
string value = 1 [(buf.validate.field).string.max_bytes = 8];
}
```
optional uint64 max_bytes = 5 [json_name = "maxBytes", (.buf.validate.priv.field) = { ... }hasMaxBytes in interface StringRulesOrBuilderpublic long getMaxBytes()
`max_bytes` specifies that the field value must have no more than the
specified number of bytes. If the field value contains more bytes, an
error message will be generated.
```proto
message MyString {
// value length must be at most 8 bytes
string value = 1 [(buf.validate.field).string.max_bytes = 8];
}
```
optional uint64 max_bytes = 5 [json_name = "maxBytes", (.buf.validate.priv.field) = { ... }getMaxBytes in interface StringRulesOrBuilderpublic boolean hasPattern()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters. If the field value doesn't match the regular expression, an
error message will be generated.
```proto
message MyString {
// value does not match regex pattern `^[a-zA-Z]//$`
string value = 1 [(buf.validate.field).string.pattern = "^[a-zA-Z]//$"];
}
```
optional string pattern = 6 [json_name = "pattern", (.buf.validate.priv.field) = { ... }hasPattern in interface StringRulesOrBuilderpublic String getPattern()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters. If the field value doesn't match the regular expression, an
error message will be generated.
```proto
message MyString {
// value does not match regex pattern `^[a-zA-Z]//$`
string value = 1 [(buf.validate.field).string.pattern = "^[a-zA-Z]//$"];
}
```
optional string pattern = 6 [json_name = "pattern", (.buf.validate.priv.field) = { ... }getPattern in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getPatternBytes()
`pattern` specifies that the field value must match the specified
regular expression (RE2 syntax), with the expression provided without any
delimiters. If the field value doesn't match the regular expression, an
error message will be generated.
```proto
message MyString {
// value does not match regex pattern `^[a-zA-Z]//$`
string value = 1 [(buf.validate.field).string.pattern = "^[a-zA-Z]//$"];
}
```
optional string pattern = 6 [json_name = "pattern", (.buf.validate.priv.field) = { ... }getPatternBytes in interface StringRulesOrBuilderpublic boolean hasPrefix()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string. If the field value
doesn't start with the specified prefix, an error message will be
generated.
```proto
message MyString {
// value does not have prefix `pre`
string value = 1 [(buf.validate.field).string.prefix = "pre"];
}
```
optional string prefix = 7 [json_name = "prefix", (.buf.validate.priv.field) = { ... }hasPrefix in interface StringRulesOrBuilderpublic String getPrefix()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string. If the field value
doesn't start with the specified prefix, an error message will be
generated.
```proto
message MyString {
// value does not have prefix `pre`
string value = 1 [(buf.validate.field).string.prefix = "pre"];
}
```
optional string prefix = 7 [json_name = "prefix", (.buf.validate.priv.field) = { ... }getPrefix in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getPrefixBytes()
`prefix` specifies that the field value must have the
specified substring at the beginning of the string. If the field value
doesn't start with the specified prefix, an error message will be
generated.
```proto
message MyString {
// value does not have prefix `pre`
string value = 1 [(buf.validate.field).string.prefix = "pre"];
}
```
optional string prefix = 7 [json_name = "prefix", (.buf.validate.priv.field) = { ... }getPrefixBytes in interface StringRulesOrBuilderpublic boolean hasSuffix()
`suffix` specifies that the field value must have the
specified substring at the end of the string. If the field value doesn't
end with the specified suffix, an error message will be generated.
```proto
message MyString {
// value does not have suffix `post`
string value = 1 [(buf.validate.field).string.suffix = "post"];
}
```
optional string suffix = 8 [json_name = "suffix", (.buf.validate.priv.field) = { ... }hasSuffix in interface StringRulesOrBuilderpublic String getSuffix()
`suffix` specifies that the field value must have the
specified substring at the end of the string. If the field value doesn't
end with the specified suffix, an error message will be generated.
```proto
message MyString {
// value does not have suffix `post`
string value = 1 [(buf.validate.field).string.suffix = "post"];
}
```
optional string suffix = 8 [json_name = "suffix", (.buf.validate.priv.field) = { ... }getSuffix in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getSuffixBytes()
`suffix` specifies that the field value must have the
specified substring at the end of the string. If the field value doesn't
end with the specified suffix, an error message will be generated.
```proto
message MyString {
// value does not have suffix `post`
string value = 1 [(buf.validate.field).string.suffix = "post"];
}
```
optional string suffix = 8 [json_name = "suffix", (.buf.validate.priv.field) = { ... }getSuffixBytes in interface StringRulesOrBuilderpublic boolean hasContains()
`contains` specifies that the field value must have the
specified substring anywhere in the string. If the field value doesn't
contain the specified substring, an error message will be generated.
```proto
message MyString {
// value does not contain substring `inside`.
string value = 1 [(buf.validate.field).string.contains = "inside"];
}
```
optional string contains = 9 [json_name = "contains", (.buf.validate.priv.field) = { ... }hasContains in interface StringRulesOrBuilderpublic String getContains()
`contains` specifies that the field value must have the
specified substring anywhere in the string. If the field value doesn't
contain the specified substring, an error message will be generated.
```proto
message MyString {
// value does not contain substring `inside`.
string value = 1 [(buf.validate.field).string.contains = "inside"];
}
```
optional string contains = 9 [json_name = "contains", (.buf.validate.priv.field) = { ... }getContains in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getContainsBytes()
`contains` specifies that the field value must have the
specified substring anywhere in the string. If the field value doesn't
contain the specified substring, an error message will be generated.
```proto
message MyString {
// value does not contain substring `inside`.
string value = 1 [(buf.validate.field).string.contains = "inside"];
}
```
optional string contains = 9 [json_name = "contains", (.buf.validate.priv.field) = { ... }getContainsBytes in interface StringRulesOrBuilderpublic boolean hasNotContains()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string. If the field value contains
the specified substring, an error message will be generated.
```proto
message MyString {
// value contains substring `inside`.
string value = 1 [(buf.validate.field).string.not_contains = "inside"];
}
```
optional string not_contains = 23 [json_name = "notContains", (.buf.validate.priv.field) = { ... }hasNotContains in interface StringRulesOrBuilderpublic String getNotContains()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string. If the field value contains
the specified substring, an error message will be generated.
```proto
message MyString {
// value contains substring `inside`.
string value = 1 [(buf.validate.field).string.not_contains = "inside"];
}
```
optional string not_contains = 23 [json_name = "notContains", (.buf.validate.priv.field) = { ... }getNotContains in interface StringRulesOrBuilderpublic com.google.protobuf.ByteString getNotContainsBytes()
`not_contains` specifies that the field value must not have the
specified substring anywhere in the string. If the field value contains
the specified substring, an error message will be generated.
```proto
message MyString {
// value contains substring `inside`.
string value = 1 [(buf.validate.field).string.not_contains = "inside"];
}
```
optional string not_contains = 23 [json_name = "notContains", (.buf.validate.priv.field) = { ... }getNotContainsBytes in interface StringRulesOrBuilderpublic com.google.protobuf.ProtocolStringList getInList()
`in` specifies that the field value must be equal to one of the specified
values. If the field value isn't one of the specified values, an error
message will be generated.
```proto
message MyString {
// value must be in list ["apple", "banana"]
repeated string value = 1 [(buf.validate.field).string.in = "apple", (buf.validate.field).string.in = "banana"];
}
```
repeated string in = 10 [json_name = "in", (.buf.validate.priv.field) = { ... }getInList in interface StringRulesOrBuilderpublic int getInCount()
`in` specifies that the field value must be equal to one of the specified
values. If the field value isn't one of the specified values, an error
message will be generated.
```proto
message MyString {
// value must be in list ["apple", "banana"]
repeated string value = 1 [(buf.validate.field).string.in = "apple", (buf.validate.field).string.in = "banana"];
}
```
repeated string in = 10 [json_name = "in", (.buf.validate.priv.field) = { ... }getInCount in interface StringRulesOrBuilderpublic String getIn(int index)
`in` specifies that the field value must be equal to one of the specified
values. If the field value isn't one of the specified values, an error
message will be generated.
```proto
message MyString {
// value must be in list ["apple", "banana"]
repeated string value = 1 [(buf.validate.field).string.in = "apple", (buf.validate.field).string.in = "banana"];
}
```
repeated string in = 10 [json_name = "in", (.buf.validate.priv.field) = { ... }getIn in interface StringRulesOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getInBytes(int index)
`in` specifies that the field value must be equal to one of the specified
values. If the field value isn't one of the specified values, an error
message will be generated.
```proto
message MyString {
// value must be in list ["apple", "banana"]
repeated string value = 1 [(buf.validate.field).string.in = "apple", (buf.validate.field).string.in = "banana"];
}
```
repeated string in = 10 [json_name = "in", (.buf.validate.priv.field) = { ... }getInBytes in interface StringRulesOrBuilderindex - The index of the value to return.public com.google.protobuf.ProtocolStringList getNotInList()
`not_in` specifies that the field value cannot be equal to any
of the specified values. If the field value is one of the specified values,
an error message will be generated.
```proto
message MyString {
// value must not be in list ["orange", "grape"]
repeated string value = 1 [(buf.validate.field).string.not_in = "orange", (buf.validate.field).string.not_in = "grape"];
}
```
repeated string not_in = 11 [json_name = "notIn", (.buf.validate.priv.field) = { ... }getNotInList in interface StringRulesOrBuilderpublic int getNotInCount()
`not_in` specifies that the field value cannot be equal to any
of the specified values. If the field value is one of the specified values,
an error message will be generated.
```proto
message MyString {
// value must not be in list ["orange", "grape"]
repeated string value = 1 [(buf.validate.field).string.not_in = "orange", (buf.validate.field).string.not_in = "grape"];
}
```
repeated string not_in = 11 [json_name = "notIn", (.buf.validate.priv.field) = { ... }getNotInCount in interface StringRulesOrBuilderpublic String getNotIn(int index)
`not_in` specifies that the field value cannot be equal to any
of the specified values. If the field value is one of the specified values,
an error message will be generated.
```proto
message MyString {
// value must not be in list ["orange", "grape"]
repeated string value = 1 [(buf.validate.field).string.not_in = "orange", (buf.validate.field).string.not_in = "grape"];
}
```
repeated string not_in = 11 [json_name = "notIn", (.buf.validate.priv.field) = { ... }getNotIn in interface StringRulesOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getNotInBytes(int index)
`not_in` specifies that the field value cannot be equal to any
of the specified values. If the field value is one of the specified values,
an error message will be generated.
```proto
message MyString {
// value must not be in list ["orange", "grape"]
repeated string value = 1 [(buf.validate.field).string.not_in = "orange", (buf.validate.field).string.not_in = "grape"];
}
```
repeated string not_in = 11 [json_name = "notIn", (.buf.validate.priv.field) = { ... }getNotInBytes in interface StringRulesOrBuilderindex - The index of the value to return.public boolean hasEmail()
`email` specifies that the field value must be a valid email address
(addr-spec only) as defined by [RFC 5322](https://tools.ietf.org/html/rfc5322#section-3.4.1).
If the field value isn't a valid email address, an error message will be generated.
```proto
message MyString {
// value must be a valid email address
string value = 1 [(buf.validate.field).string.email = true];
}
```
bool email = 12 [json_name = "email", (.buf.validate.priv.field) = { ... }hasEmail in interface StringRulesOrBuilderpublic boolean getEmail()
`email` specifies that the field value must be a valid email address
(addr-spec only) as defined by [RFC 5322](https://tools.ietf.org/html/rfc5322#section-3.4.1).
If the field value isn't a valid email address, an error message will be generated.
```proto
message MyString {
// value must be a valid email address
string value = 1 [(buf.validate.field).string.email = true];
}
```
bool email = 12 [json_name = "email", (.buf.validate.priv.field) = { ... }getEmail in interface StringRulesOrBuilderpublic boolean hasHostname()
`hostname` specifies that the field value must be a valid
hostname as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5). This constraint doesn't support
internationalized domain names (IDNs). If the field value isn't a
valid hostname, an error message will be generated.
```proto
message MyString {
// value must be a valid hostname
string value = 1 [(buf.validate.field).string.hostname = true];
}
```
bool hostname = 13 [json_name = "hostname", (.buf.validate.priv.field) = { ... }hasHostname in interface StringRulesOrBuilderpublic boolean getHostname()
`hostname` specifies that the field value must be a valid
hostname as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5). This constraint doesn't support
internationalized domain names (IDNs). If the field value isn't a
valid hostname, an error message will be generated.
```proto
message MyString {
// value must be a valid hostname
string value = 1 [(buf.validate.field).string.hostname = true];
}
```
bool hostname = 13 [json_name = "hostname", (.buf.validate.priv.field) = { ... }getHostname in interface StringRulesOrBuilderpublic boolean hasIp()
`ip` specifies that the field value must be a valid IP
(v4 or v6) address, without surrounding square brackets for IPv6 addresses.
If the field value isn't a valid IP address, an error message will be
generated.
```proto
message MyString {
// value must be a valid IP address
string value = 1 [(buf.validate.field).string.ip = true];
}
```
bool ip = 14 [json_name = "ip", (.buf.validate.priv.field) = { ... }hasIp in interface StringRulesOrBuilderpublic boolean getIp()
`ip` specifies that the field value must be a valid IP
(v4 or v6) address, without surrounding square brackets for IPv6 addresses.
If the field value isn't a valid IP address, an error message will be
generated.
```proto
message MyString {
// value must be a valid IP address
string value = 1 [(buf.validate.field).string.ip = true];
}
```
bool ip = 14 [json_name = "ip", (.buf.validate.priv.field) = { ... }getIp in interface StringRulesOrBuilderpublic boolean hasIpv4()
`ipv4` specifies that the field value must be a valid IPv4
address. If the field value isn't a valid IPv4 address, an error message
will be generated.
```proto
message MyString {
// value must be a valid IPv4 address
string value = 1 [(buf.validate.field).string.ipv4 = true];
}
```
bool ipv4 = 15 [json_name = "ipv4", (.buf.validate.priv.field) = { ... }hasIpv4 in interface StringRulesOrBuilderpublic boolean getIpv4()
`ipv4` specifies that the field value must be a valid IPv4
address. If the field value isn't a valid IPv4 address, an error message
will be generated.
```proto
message MyString {
// value must be a valid IPv4 address
string value = 1 [(buf.validate.field).string.ipv4 = true];
}
```
bool ipv4 = 15 [json_name = "ipv4", (.buf.validate.priv.field) = { ... }getIpv4 in interface StringRulesOrBuilderpublic boolean hasIpv6()
`ipv6` specifies that the field value must be a valid
IPv6 address, without surrounding square brackets. If the field value is
not a valid IPv6 address, an error message will be generated.
```proto
message MyString {
// value must be a valid IPv6 address
string value = 1 [(buf.validate.field).string.ipv6 = true];
}
```
bool ipv6 = 16 [json_name = "ipv6", (.buf.validate.priv.field) = { ... }hasIpv6 in interface StringRulesOrBuilderpublic boolean getIpv6()
`ipv6` specifies that the field value must be a valid
IPv6 address, without surrounding square brackets. If the field value is
not a valid IPv6 address, an error message will be generated.
```proto
message MyString {
// value must be a valid IPv6 address
string value = 1 [(buf.validate.field).string.ipv6 = true];
}
```
bool ipv6 = 16 [json_name = "ipv6", (.buf.validate.priv.field) = { ... }getIpv6 in interface StringRulesOrBuilderpublic boolean hasUri()
`uri` specifies that the field value must be a valid,
absolute URI as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3). If the field value isn't a valid,
absolute URI, an error message will be generated.
```proto
message MyString {
// value must be a valid URI
string value = 1 [(buf.validate.field).string.uri = true];
}
```
bool uri = 17 [json_name = "uri", (.buf.validate.priv.field) = { ... }hasUri in interface StringRulesOrBuilderpublic boolean getUri()
`uri` specifies that the field value must be a valid,
absolute URI as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3). If the field value isn't a valid,
absolute URI, an error message will be generated.
```proto
message MyString {
// value must be a valid URI
string value = 1 [(buf.validate.field).string.uri = true];
}
```
bool uri = 17 [json_name = "uri", (.buf.validate.priv.field) = { ... }getUri in interface StringRulesOrBuilderpublic boolean hasUriRef()
`uri_ref` specifies that the field value must be a valid URI
as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) and may be either relative or absolute. If the
field value isn't a valid URI, an error message will be generated.
```proto
message MyString {
// value must be a valid URI
string value = 1 [(buf.validate.field).string.uri_ref = true];
}
```
bool uri_ref = 18 [json_name = "uriRef", (.buf.validate.priv.field) = { ... }hasUriRef in interface StringRulesOrBuilderpublic boolean getUriRef()
`uri_ref` specifies that the field value must be a valid URI
as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-3) and may be either relative or absolute. If the
field value isn't a valid URI, an error message will be generated.
```proto
message MyString {
// value must be a valid URI
string value = 1 [(buf.validate.field).string.uri_ref = true];
}
```
bool uri_ref = 18 [json_name = "uriRef", (.buf.validate.priv.field) = { ... }getUriRef in interface StringRulesOrBuilderpublic boolean hasAddress()
`address` specifies that the field value must be either a valid hostname
as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5)
(which doesn't support internationalized domain names or IDNs) or a valid
IP (v4 or v6). If the field value isn't a valid hostname or IP, an error
message will be generated.
```proto
message MyString {
// value must be a valid hostname, or ip address
string value = 1 [(buf.validate.field).string.address = true];
}
```
bool address = 21 [json_name = "address", (.buf.validate.priv.field) = { ... }hasAddress in interface StringRulesOrBuilderpublic boolean getAddress()
`address` specifies that the field value must be either a valid hostname
as defined by [RFC 1034](https://tools.ietf.org/html/rfc1034#section-3.5)
(which doesn't support internationalized domain names or IDNs) or a valid
IP (v4 or v6). If the field value isn't a valid hostname or IP, an error
message will be generated.
```proto
message MyString {
// value must be a valid hostname, or ip address
string value = 1 [(buf.validate.field).string.address = true];
}
```
bool address = 21 [json_name = "address", (.buf.validate.priv.field) = { ... }getAddress in interface StringRulesOrBuilderpublic boolean hasUuid()
`uuid` specifies that the field value must be a valid UUID as defined by
[RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.2). If the
field value isn't a valid UUID, an error message will be generated.
```proto
message MyString {
// value must be a valid UUID
string value = 1 [(buf.validate.field).string.uuid = true];
}
```
bool uuid = 22 [json_name = "uuid", (.buf.validate.priv.field) = { ... }hasUuid in interface StringRulesOrBuilderpublic boolean getUuid()
`uuid` specifies that the field value must be a valid UUID as defined by
[RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.2). If the
field value isn't a valid UUID, an error message will be generated.
```proto
message MyString {
// value must be a valid UUID
string value = 1 [(buf.validate.field).string.uuid = true];
}
```
bool uuid = 22 [json_name = "uuid", (.buf.validate.priv.field) = { ... }getUuid in interface StringRulesOrBuilderpublic boolean hasIpWithPrefixlen()
`ip_with_prefixlen` specifies that the field value must be a valid IP (v4 or v6)
address with prefix length. If the field value isn't a valid IP with prefix
length, an error message will be generated.
```proto
message MyString {
// value must be a valid IP with prefix length
string value = 1 [(buf.validate.field).string.ip_with_prefixlen = true];
}
```
bool ip_with_prefixlen = 26 [json_name = "ipWithPrefixlen", (.buf.validate.priv.field) = { ... }hasIpWithPrefixlen in interface StringRulesOrBuilderpublic boolean getIpWithPrefixlen()
`ip_with_prefixlen` specifies that the field value must be a valid IP (v4 or v6)
address with prefix length. If the field value isn't a valid IP with prefix
length, an error message will be generated.
```proto
message MyString {
// value must be a valid IP with prefix length
string value = 1 [(buf.validate.field).string.ip_with_prefixlen = true];
}
```
bool ip_with_prefixlen = 26 [json_name = "ipWithPrefixlen", (.buf.validate.priv.field) = { ... }getIpWithPrefixlen in interface StringRulesOrBuilderpublic boolean hasIpv4WithPrefixlen()
`ipv4_with_prefixlen` specifies that the field value must be a valid
IPv4 address with prefix.
If the field value isn't a valid IPv4 address with prefix length,
an error message will be generated.
```proto
message MyString {
// value must be a valid IPv4 address with prefix lentgh
string value = 1 [(buf.validate.field).string.ipv4_with_prefixlen = true];
}
```
bool ipv4_with_prefixlen = 27 [json_name = "ipv4WithPrefixlen", (.buf.validate.priv.field) = { ... }hasIpv4WithPrefixlen in interface StringRulesOrBuilderpublic boolean getIpv4WithPrefixlen()
`ipv4_with_prefixlen` specifies that the field value must be a valid
IPv4 address with prefix.
If the field value isn't a valid IPv4 address with prefix length,
an error message will be generated.
```proto
message MyString {
// value must be a valid IPv4 address with prefix lentgh
string value = 1 [(buf.validate.field).string.ipv4_with_prefixlen = true];
}
```
bool ipv4_with_prefixlen = 27 [json_name = "ipv4WithPrefixlen", (.buf.validate.priv.field) = { ... }getIpv4WithPrefixlen in interface StringRulesOrBuilderpublic boolean hasIpv6WithPrefixlen()
`ipv6_with_prefixlen` specifies that the field value must be a valid
IPv6 address with prefix length.
If the field value is not a valid IPv6 address with prefix length,
an error message will be generated.
```proto
message MyString {
// value must be a valid IPv6 address prefix length
string value = 1 [(buf.validate.field).string.ipv6_with_prefixlen = true];
}
```
bool ipv6_with_prefixlen = 28 [json_name = "ipv6WithPrefixlen", (.buf.validate.priv.field) = { ... }hasIpv6WithPrefixlen in interface StringRulesOrBuilderpublic boolean getIpv6WithPrefixlen()
`ipv6_with_prefixlen` specifies that the field value must be a valid
IPv6 address with prefix length.
If the field value is not a valid IPv6 address with prefix length,
an error message will be generated.
```proto
message MyString {
// value must be a valid IPv6 address prefix length
string value = 1 [(buf.validate.field).string.ipv6_with_prefixlen = true];
}
```
bool ipv6_with_prefixlen = 28 [json_name = "ipv6WithPrefixlen", (.buf.validate.priv.field) = { ... }getIpv6WithPrefixlen in interface StringRulesOrBuilderpublic boolean hasIpPrefix()
`ip_prefix` specifies that the field value must be a valid IP (v4 or v6) prefix.
If the field value isn't a valid IP prefix, an error message will be
generated. The prefix must have all zeros for the masked bits of the prefix (e.g.,
`127.0.0.0/16`, not `127.0.0.1/16`).
```proto
message MyString {
// value must be a valid IP prefix
string value = 1 [(buf.validate.field).string.ip_prefix = true];
}
```
bool ip_prefix = 29 [json_name = "ipPrefix", (.buf.validate.priv.field) = { ... }hasIpPrefix in interface StringRulesOrBuilderpublic boolean getIpPrefix()
`ip_prefix` specifies that the field value must be a valid IP (v4 or v6) prefix.
If the field value isn't a valid IP prefix, an error message will be
generated. The prefix must have all zeros for the masked bits of the prefix (e.g.,
`127.0.0.0/16`, not `127.0.0.1/16`).
```proto
message MyString {
// value must be a valid IP prefix
string value = 1 [(buf.validate.field).string.ip_prefix = true];
}
```
bool ip_prefix = 29 [json_name = "ipPrefix", (.buf.validate.priv.field) = { ... }getIpPrefix in interface StringRulesOrBuilderpublic boolean hasIpv4Prefix()
`ipv4_prefix` specifies that the field value must be a valid IPv4
prefix. If the field value isn't a valid IPv4 prefix, an error message
will be generated. The prefix must have all zeros for the masked bits of
the prefix (e.g., `127.0.0.0/16`, not `127.0.0.1/16`).
```proto
message MyString {
// value must be a valid IPv4 prefix
string value = 1 [(buf.validate.field).string.ipv4_prefix = true];
}
```
bool ipv4_prefix = 30 [json_name = "ipv4Prefix", (.buf.validate.priv.field) = { ... }hasIpv4Prefix in interface StringRulesOrBuilderpublic boolean getIpv4Prefix()
`ipv4_prefix` specifies that the field value must be a valid IPv4
prefix. If the field value isn't a valid IPv4 prefix, an error message
will be generated. The prefix must have all zeros for the masked bits of
the prefix (e.g., `127.0.0.0/16`, not `127.0.0.1/16`).
```proto
message MyString {
// value must be a valid IPv4 prefix
string value = 1 [(buf.validate.field).string.ipv4_prefix = true];
}
```
bool ipv4_prefix = 30 [json_name = "ipv4Prefix", (.buf.validate.priv.field) = { ... }getIpv4Prefix in interface StringRulesOrBuilderpublic boolean hasIpv6Prefix()
`ipv6_prefix` specifies that the field value must be a valid IPv6 prefix.
If the field value is not a valid IPv6 prefix, an error message will be
generated. The prefix must have all zeros for the masked bits of the prefix
(e.g., `2001:db8::/48`, not `2001:db8::1/48`).
```proto
message MyString {
// value must be a valid IPv6 prefix
string value = 1 [(buf.validate.field).string.ipv6_prefix = true];
}
```
bool ipv6_prefix = 31 [json_name = "ipv6Prefix", (.buf.validate.priv.field) = { ... }hasIpv6Prefix in interface StringRulesOrBuilderpublic boolean getIpv6Prefix()
`ipv6_prefix` specifies that the field value must be a valid IPv6 prefix.
If the field value is not a valid IPv6 prefix, an error message will be
generated. The prefix must have all zeros for the masked bits of the prefix
(e.g., `2001:db8::/48`, not `2001:db8::1/48`).
```proto
message MyString {
// value must be a valid IPv6 prefix
string value = 1 [(buf.validate.field).string.ipv6_prefix = true];
}
```
bool ipv6_prefix = 31 [json_name = "ipv6Prefix", (.buf.validate.priv.field) = { ... }getIpv6Prefix in interface StringRulesOrBuilderpublic boolean hasWellKnownRegex()
`well_known_regex` specifies a common well-known pattern
defined as a regex. If the field value doesn't match the well-known
regex, an error message will be generated.
```proto
message MyString {
// value must be a valid HTTP header value
string value = 1 [(buf.validate.field).string.well_known_regex = 2];
}
```
#### KnownRegex
`well_known_regex` contains some well-known patterns.
| Name | Number | Description |
|-------------------------------|--------|-------------------------------------------|
| KNOWN_REGEX_UNSPECIFIED | 0 | |
| KNOWN_REGEX_HTTP_HEADER_NAME | 1 | HTTP header name as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2) |
| KNOWN_REGEX_HTTP_HEADER_VALUE | 2 | HTTP header value as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.4) |
.buf.validate.KnownRegex well_known_regex = 24 [json_name = "wellKnownRegex", (.buf.validate.priv.field) = { ... }hasWellKnownRegex in interface StringRulesOrBuilderpublic int getWellKnownRegexValue()
`well_known_regex` specifies a common well-known pattern
defined as a regex. If the field value doesn't match the well-known
regex, an error message will be generated.
```proto
message MyString {
// value must be a valid HTTP header value
string value = 1 [(buf.validate.field).string.well_known_regex = 2];
}
```
#### KnownRegex
`well_known_regex` contains some well-known patterns.
| Name | Number | Description |
|-------------------------------|--------|-------------------------------------------|
| KNOWN_REGEX_UNSPECIFIED | 0 | |
| KNOWN_REGEX_HTTP_HEADER_NAME | 1 | HTTP header name as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2) |
| KNOWN_REGEX_HTTP_HEADER_VALUE | 2 | HTTP header value as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.4) |
.buf.validate.KnownRegex well_known_regex = 24 [json_name = "wellKnownRegex", (.buf.validate.priv.field) = { ... }getWellKnownRegexValue in interface StringRulesOrBuilderpublic KnownRegex getWellKnownRegex()
`well_known_regex` specifies a common well-known pattern
defined as a regex. If the field value doesn't match the well-known
regex, an error message will be generated.
```proto
message MyString {
// value must be a valid HTTP header value
string value = 1 [(buf.validate.field).string.well_known_regex = 2];
}
```
#### KnownRegex
`well_known_regex` contains some well-known patterns.
| Name | Number | Description |
|-------------------------------|--------|-------------------------------------------|
| KNOWN_REGEX_UNSPECIFIED | 0 | |
| KNOWN_REGEX_HTTP_HEADER_NAME | 1 | HTTP header name as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2) |
| KNOWN_REGEX_HTTP_HEADER_VALUE | 2 | HTTP header value as defined by [RFC 7230](https://tools.ietf.org/html/rfc7230#section-3.2.4) |
.buf.validate.KnownRegex well_known_regex = 24 [json_name = "wellKnownRegex", (.buf.validate.priv.field) = { ... }getWellKnownRegex in interface StringRulesOrBuilderpublic boolean hasStrict()
This applies to regexes `HTTP_HEADER_NAME` and `HTTP_HEADER_VALUE` to
enable strict header validation. By default, this is true, and HTTP header
validations are [RFC-compliant](https://tools.ietf.org/html/rfc7230#section-3). Setting to false will enable looser
validations that only disallow `\r\n\0` characters, which can be used to
bypass header matching rules.
```proto
message MyString {
// The field `value` must have be a valid HTTP headers, but not enforced with strict rules.
string value = 1 [(buf.validate.field).string.strict = false];
}
```
optional bool strict = 25 [json_name = "strict"];hasStrict in interface StringRulesOrBuilderpublic boolean getStrict()
This applies to regexes `HTTP_HEADER_NAME` and `HTTP_HEADER_VALUE` to
enable strict header validation. By default, this is true, and HTTP header
validations are [RFC-compliant](https://tools.ietf.org/html/rfc7230#section-3). Setting to false will enable looser
validations that only disallow `\r\n\0` characters, which can be used to
bypass header matching rules.
```proto
message MyString {
// The field `value` must have be a valid HTTP headers, but not enforced with strict rules.
string value = 1 [(buf.validate.field).string.strict = false];
}
```
optional bool strict = 25 [json_name = "strict"];getStrict in interface StringRulesOrBuilderpublic static StringRules parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static StringRules parseFrom(InputStream input) throws IOException
IOExceptionpublic static StringRules parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StringRules parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static StringRules parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static StringRules parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static StringRules parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic StringRules.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static StringRules.Builder newBuilder()
public static StringRules.Builder newBuilder(StringRules prototype)
public StringRules.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected StringRules.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static StringRules getDefaultInstance()
public static com.google.protobuf.Parser<StringRules> parser()
public com.google.protobuf.Parser<StringRules> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public StringRules getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023. All rights reserved.