package validate
Get desktop application:
View/edit binary Protocol Buffers messages
message
validate.proto:778AnyRules describe constraints applied exclusively to the `google.protobuf.Any` well-known type
Used in:
optional bool required = 1
Required specifies that this field must be set
repeated string in = 2
In specifies that this field's `type_url` must be equal to one of the specified values.
repeated string not_in = 3
NotIn specifies that this field's `type_url` must not be equal to any of the specified values.
message
validate.proto:501BoolRules describes the constraints applied to `bool` values
Used in:
optional bool const = 1
Const specifies that this field must be exactly the specified value
message
validate.proto:634BytesRules describe the constraints applied to `bytes` values
Used in:
optional bytes const = 1
Const specifies that this field must be exactly the specified value
optional uint64 len = 13
Len specifies that this field must be the specified number of bytes
optional uint64 min_len = 2
MinLen specifies that this field must be the specified number of bytes at a minimum
optional uint64 max_len = 3
MaxLen specifies that this field must be the specified number of bytes at a maximum
optional string pattern = 4
Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.
optional bytes prefix = 5
Prefix specifies that this field must have the specified bytes at the beginning of the string.
optional bytes suffix = 6
Suffix specifies that this field must have the specified bytes at the end of the string.
optional bytes contains = 7
Contains specifies that this field must have the specified bytes anywhere in the string.
repeated bytes in = 8
In specifies that this field must be equal to one of the specified values
repeated bytes not_in = 9
NotIn specifies that this field cannot be equal to one of the specified values
oneof well_known
WellKnown rules provide advanced constraints against common byte patterns
bool ip = 10
Ip specifies that the field must be a valid IP (v4 or v6) address in byte format
bool ipv4 = 11
Ipv4 specifies that the field must be a valid IPv4 address in byte format
bool ipv6 = 12
Ipv6 specifies that the field must be a valid IPv6 address in byte format
optional bool ignore_empty = 14
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:105DoubleRules describes the constraints applied to `double` values
Used in:
optional double const = 1
Const specifies that this field must be exactly the specified value
optional double lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional double lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional double gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional double gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated double in = 6
In specifies that this field must be equal to one of the specified values
repeated double not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:793DurationRules describe the constraints applied exclusively to the `google.protobuf.Duration` well-known type
Used in:
optional bool required = 1
Required specifies that this field must be set
optional const = 2
Const specifies that this field must be exactly the specified value
optional lt = 3
Lt specifies that this field must be less than the specified value, exclusive
optional lte = 4
Lt specifies that this field must be less than the specified value, inclusive
optional gt = 5
Gt specifies that this field must be greater than the specified value, exclusive
optional gte = 6
Gte specifies that this field must be greater than the specified value, inclusive
repeated in = 7
In specifies that this field must be equal to one of the specified values
repeated not_in = 8
NotIn specifies that this field cannot be equal to one of the specified values
message
validate.proto:696EnumRules describe the constraints applied to enum values
Used in:
optional int32 const = 1
Const specifies that this field must be exactly the specified value
optional bool defined_only = 2
DefinedOnly specifies that this field must be only one of the defined values for this enum, failing on any undefined value.
repeated int32 in = 3
In specifies that this field must be equal to one of the specified values
repeated int32 not_in = 4
NotIn specifies that this field cannot be equal to one of the specified values
message
validate.proto:36FieldRules encapsulates the rules for each type of field. Depending on the field, the correct set should be used to ensure proper validations.
Used in: ,
optional message = 17
oneof type
float = 1
Scalar Field Types
double = 2
int32 = 3
int64 = 4
uint32 = 5
uint64 = 6
sint32 = 7
sint64 = 8
fixed32 = 9
fixed64 = 10
sfixed32 = 11
sfixed64 = 12
bool = 13
string = 14
bytes = 15
enum = 16
Complex Field Types
repeated = 18
map = 19
any = 20
Well-Known Field Types
duration = 21
timestamp = 22
message
validate.proto:357Fixed32Rules describes the constraints applied to `fixed32` values
Used in:
optional fixed32 const = 1
Const specifies that this field must be exactly the specified value
optional fixed32 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional fixed32 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional fixed32 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional fixed32 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated fixed32 in = 6
In specifies that this field must be equal to one of the specified values
repeated fixed32 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:393Fixed64Rules describes the constraints applied to `fixed64` values
Used in:
optional fixed64 const = 1
Const specifies that this field must be exactly the specified value
optional fixed64 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional fixed64 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional fixed64 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional fixed64 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated fixed64 in = 6
In specifies that this field must be equal to one of the specified values
repeated fixed64 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:69FloatRules describes the constraints applied to `float` values
Used in:
optional float const = 1
Const specifies that this field must be exactly the specified value
optional float lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional float lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional float gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional float gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated float in = 6
In specifies that this field must be equal to one of the specified values
repeated float not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:141Int32Rules describes the constraints applied to `int32` values
Used in:
optional int32 const = 1
Const specifies that this field must be exactly the specified value
optional int32 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional int32 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional int32 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional int32 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated int32 in = 6
In specifies that this field must be equal to one of the specified values
repeated int32 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:177Int64Rules describes the constraints applied to `int64` values
Used in:
optional int64 const = 1
Const specifies that this field must be exactly the specified value
optional int64 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional int64 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional int64 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional int64 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated int64 in = 6
In specifies that this field must be equal to one of the specified values
repeated int64 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
WellKnownRegex contain some well-known patterns.
Used in:
UNKNOWN = 0
HTTP_HEADER_NAME = 1
HTTP header name as defined by RFC 7230.
HTTP_HEADER_VALUE = 2
HTTP header value as defined by RFC 7230.
message
validate.proto:750MapRules describe the constraints applied to `map` values
Used in:
optional uint64 min_pairs = 1
MinPairs specifies that this field must have the specified number of KVs at a minimum
optional uint64 max_pairs = 2
MaxPairs specifies that this field must have the specified number of KVs at a maximum
optional bool no_sparse = 3
NoSparse specifies values in this field cannot be unset. This only applies to map's with message value types.
optional keys = 4
Keys specifies the constraints to be applied to each key in the field.
optional values = 5
Values specifies the constraints to be applied to the value of each key in the field. Message values will still have their validations evaluated unless skip is specified here.
optional bool ignore_empty = 6
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:715MessageRules describe the constraints applied to embedded message values. For message-type fields, validation is performed recursively.
Used in:
optional bool skip = 1
Skip specifies that the validation rules of this field should not be evaluated
optional bool required = 2
Required specifies that this field must be set
message
validate.proto:725RepeatedRules describe the constraints applied to `repeated` values
Used in:
optional uint64 min_items = 1
MinItems specifies that this field must have the specified number of items at a minimum
optional uint64 max_items = 2
MaxItems specifies that this field must have the specified number of items at a maximum
optional bool unique = 3
Unique specifies that all elements in this field must be unique. This contraint is only applicable to scalar and enum types (messages are not supported).
optional items = 4
Items specifies the contraints to be applied to each item in the field. Repeated message fields will still execute validation against each item unless skip is specified here.
optional bool ignore_empty = 5
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:429SFixed32Rules describes the constraints applied to `sfixed32` values
Used in:
optional sfixed32 const = 1
Const specifies that this field must be exactly the specified value
optional sfixed32 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional sfixed32 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional sfixed32 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional sfixed32 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated sfixed32 in = 6
In specifies that this field must be equal to one of the specified values
repeated sfixed32 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:465SFixed64Rules describes the constraints applied to `sfixed64` values
Used in:
optional sfixed64 const = 1
Const specifies that this field must be exactly the specified value
optional sfixed64 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional sfixed64 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional sfixed64 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional sfixed64 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated sfixed64 in = 6
In specifies that this field must be equal to one of the specified values
repeated sfixed64 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:285SInt32Rules describes the constraints applied to `sint32` values
Used in:
optional sint32 const = 1
Const specifies that this field must be exactly the specified value
optional sint32 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional sint32 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional sint32 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional sint32 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated sint32 in = 6
In specifies that this field must be equal to one of the specified values
repeated sint32 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:321SInt64Rules describes the constraints applied to `sint64` values
Used in:
optional sint64 const = 1
Const specifies that this field must be exactly the specified value
optional sint64 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional sint64 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional sint64 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional sint64 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated sint64 in = 6
In specifies that this field must be equal to one of the specified values
repeated sint64 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:507StringRules describe the constraints applied to `string` values
Used in:
optional string const = 1
Const specifies that this field must be exactly the specified value
optional uint64 len = 19
Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string.
optional uint64 min_len = 2
MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string.
optional uint64 max_len = 3
MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string.
optional uint64 len_bytes = 20
LenBytes specifies that this field must be the specified number of bytes
optional uint64 min_bytes = 4
MinBytes specifies that this field must be the specified number of bytes at a minimum
optional uint64 max_bytes = 5
MaxBytes specifies that this field must be the specified number of bytes at a maximum
optional string pattern = 6
Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.
optional string prefix = 7
Prefix specifies that this field must have the specified substring at the beginning of the string.
optional string suffix = 8
Suffix specifies that this field must have the specified substring at the end of the string.
optional string contains = 9
Contains specifies that this field must have the specified substring anywhere in the string.
optional string not_contains = 23
NotContains specifies that this field cannot have the specified substring anywhere in the string.
repeated string in = 10
In specifies that this field must be equal to one of the specified values
repeated string not_in = 11
NotIn specifies that this field cannot be equal to one of the specified values
oneof well_known
WellKnown rules provide advanced constraints against common string patterns
bool email = 12
Email specifies that the field must be a valid email address as defined by RFC 5322
bool hostname = 13
Hostname specifies that the field must be a valid hostname as defined by RFC 1034. This constraint does not support internationalized domain names (IDNs).
bool ip = 14
Ip specifies that the field must be a valid IP (v4 or v6) address. Valid IPv6 addresses should not include surrounding square brackets.
bool ipv4 = 15
Ipv4 specifies that the field must be a valid IPv4 address.
bool ipv6 = 16
Ipv6 specifies that the field must be a valid IPv6 address. Valid IPv6 addresses should not include surrounding square brackets.
bool uri = 17
Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986
bool uri_ref = 18
UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute.
bool address = 21
Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6).
bool uuid = 22
Uuid specifies that the field must be a valid UUID as defined by RFC 4122
KnownRegex well_known_regex = 24
WellKnownRegex specifies a common well known pattern defined as a regex.
optional bool strict = 25
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. Setting to false will enable a looser validations that only disallows \r\n\0 characters, which can be used to bypass header matching rules.
optional bool ignore_empty = 26
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:827TimestampRules describe the constraints applied exclusively to the `google.protobuf.Timestamp` well-known type
Used in:
optional bool required = 1
Required specifies that this field must be set
optional const = 2
Const specifies that this field must be exactly the specified value
optional lt = 3
Lt specifies that this field must be less than the specified value, exclusive
optional lte = 4
Lte specifies that this field must be less than the specified value, inclusive
optional gt = 5
Gt specifies that this field must be greater than the specified value, exclusive
optional gte = 6
Gte specifies that this field must be greater than the specified value, inclusive
optional bool lt_now = 7
LtNow specifies that this must be less than the current time. LtNow can only be used with the Within rule.
optional bool gt_now = 8
GtNow specifies that this must be greater than the current time. GtNow can only be used with the Within rule.
optional within = 9
Within specifies that this field must be within this duration of the current time. This constraint can be used alone or with the LtNow and GtNow rules.
message
validate.proto:213UInt32Rules describes the constraints applied to `uint32` values
Used in:
optional uint32 const = 1
Const specifies that this field must be exactly the specified value
optional uint32 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional uint32 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional uint32 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional uint32 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated uint32 in = 6
In specifies that this field must be equal to one of the specified values
repeated uint32 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
message
validate.proto:249UInt64Rules describes the constraints applied to `uint64` values
Used in:
optional uint64 const = 1
Const specifies that this field must be exactly the specified value
optional uint64 lt = 2
Lt specifies that this field must be less than the specified value, exclusive
optional uint64 lte = 3
Lte specifies that this field must be less than or equal to the specified value, inclusive
optional uint64 gt = 4
Gt specifies that this field must be greater than the specified value, exclusive. If the value of Gt is larger than a specified Lt or Lte, the range is reversed.
optional uint64 gte = 5
Gte specifies that this field must be greater than or equal to the specified value, inclusive. If the value of Gte is larger than a specified Lt or Lte, the range is reversed.
repeated uint64 in = 6
In specifies that this field must be equal to one of the specified values
repeated uint64 not_in = 7
NotIn specifies that this field cannot be equal to one of the specified values
optional bool ignore_empty = 8
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty