com.buf.validate

Interface UInt32RulesOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UInt32Rules, UInt32Rules.Builder

public interface UInt32RulesOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getConst() `const` requires the field value to exactly match the specified value.
UInt32Rules.GreaterThanCase	getGreaterThanCase()
int	getGt() `gt` requires the field value to be greater than the specified value (exclusive).
int	getGte() `gte` requires the field value to be greater than or equal to the specified value (exclusive).
int	getIn(int index) `in` requires the field value to be equal to one of the specified values.
int	getInCount() `in` requires the field value to be equal to one of the specified values.
List<Integer>	getInList() `in` requires the field value to be equal to one of the specified values.
UInt32Rules.LessThanCase	getLessThanCase()
int	getLt() `lt` requires the field value to be less than the specified value (field < value).
int	getLte() `lte` requires the field value to be less than or equal to the specified value (field <= value).
int	getNotIn(int index) `not_in` requires the field value to not be equal to any of the specified values.
int	getNotInCount() `not_in` requires the field value to not be equal to any of the specified values.
List<Integer>	getNotInList() `not_in` requires the field value to not be equal to any of the specified values.
boolean	hasConst() `const` requires the field value to exactly match the specified value.
boolean	hasGt() `gt` requires the field value to be greater than the specified value (exclusive).
boolean	hasGte() `gte` requires the field value to be greater than or equal to the specified value (exclusive).
boolean	hasLt() `lt` requires the field value to be less than the specified value (field < value).
boolean	hasLte() `lte` requires the field value to be less than or equal to the specified value (field <= value).

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasConst

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 MyUInt32 {
   // value must equal 42
   uint32 value = 1 [(buf.validate.field).uint32.const = 42];
 }
 ```
 

optional uint32 const = 1 [json_name = "const", (.buf.validate.priv.field) = { ... }

Returns:

Whether the const field is set.

getConst

int 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 MyUInt32 {
   // value must equal 42
   uint32 value = 1 [(buf.validate.field).uint32.const = 42];
 }
 ```
 

optional uint32 const = 1 [json_name = "const", (.buf.validate.priv.field) = { ... }

Returns:

The const.

hasLt

boolean hasLt()

 `lt` requires the field value to be less than the specified value (field <
 value). If the field value is equal to or greater than the specified value,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be less than 10
   uint32 value = 1 [(buf.validate.field).uint32.lt = 10];
 }
 ```
 

uint32 lt = 2 [json_name = "lt", (.buf.validate.priv.field) = { ... }

Returns:

Whether the lt field is set.

getLt

int getLt()

 `lt` requires the field value to be less than the specified value (field <
 value). If the field value is equal to or greater than the specified value,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be less than 10
   uint32 value = 1 [(buf.validate.field).uint32.lt = 10];
 }
 ```
 

uint32 lt = 2 [json_name = "lt", (.buf.validate.priv.field) = { ... }

Returns:

The lt.

hasLte

boolean hasLte()

 `lte` requires the field value to be less than or equal to the specified
 value (field <= value). If the field value is greater than the specified
 value, an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be less than or equal to 10
   uint32 value = 1 [(buf.validate.field).uint32.lte = 10];
 }
 ```
 

uint32 lte = 3 [json_name = "lte", (.buf.validate.priv.field) = { ... }

Returns:

Whether the lte field is set.

getLte

int getLte()

 `lte` requires the field value to be less than or equal to the specified
 value (field <= value). If the field value is greater than the specified
 value, an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be less than or equal to 10
   uint32 value = 1 [(buf.validate.field).uint32.lte = 10];
 }
 ```
 

uint32 lte = 3 [json_name = "lte", (.buf.validate.priv.field) = { ... }

Returns:

The lte.

hasGt

boolean hasGt()

 `gt` requires the field value to be greater than the specified value
 (exclusive). If the value of `gt` is larger than a specified `lt` or
 `lte`, the range is reversed, and the field value must be outside the
 specified range. If the field value doesn't meet the required conditions,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be greater than 5 [uint32.gt]
   uint32 value = 1 [(buf.validate.field).uint32.gt = 5];

   // value must be greater than 5 and less than 10 [uint32.gt_lt]
   uint32 other_value = 2 [(buf.validate.field).uint32 = { gt: 5, lt: 10 }];

   // value must be greater than 10 or less than 5 [uint32.gt_lt_exclusive]
   uint32 another_value = 3 [(buf.validate.field).uint32 = { gt: 10, lt: 5 }];
 }
 ```
 

uint32 gt = 4 [json_name = "gt", (.buf.validate.priv.field) = { ... }

Returns:

Whether the gt field is set.

getGt

int getGt()

 `gt` requires the field value to be greater than the specified value
 (exclusive). If the value of `gt` is larger than a specified `lt` or
 `lte`, the range is reversed, and the field value must be outside the
 specified range. If the field value doesn't meet the required conditions,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be greater than 5 [uint32.gt]
   uint32 value = 1 [(buf.validate.field).uint32.gt = 5];

   // value must be greater than 5 and less than 10 [uint32.gt_lt]
   uint32 other_value = 2 [(buf.validate.field).uint32 = { gt: 5, lt: 10 }];

   // value must be greater than 10 or less than 5 [uint32.gt_lt_exclusive]
   uint32 another_value = 3 [(buf.validate.field).uint32 = { gt: 10, lt: 5 }];
 }
 ```
 

uint32 gt = 4 [json_name = "gt", (.buf.validate.priv.field) = { ... }

Returns:

The gt.

hasGte

boolean hasGte()

 `gte` requires the field value to be greater than or equal to the specified
 value (exclusive). If the value of `gte` is larger than a specified `lt`
 or `lte`, the range is reversed, and the field value must be outside the
 specified range. If the field value doesn't meet the required conditions,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be greater than or equal to 5 [uint32.gte]
   uint32 value = 1 [(buf.validate.field).uint32.gte = 5];

   // value must be greater than or equal to 5 and less than 10 [uint32.gte_lt]
   uint32 other_value = 2 [(buf.validate.field).uint32 = { gte: 5, lt: 10 }];

   // value must be greater than or equal to 10 or less than 5 [uint32.gte_lt_exclusive]
   uint32 another_value = 3 [(buf.validate.field).uint32 = { gte: 10, lt: 5 }];
 }
 ```
 

uint32 gte = 5 [json_name = "gte", (.buf.validate.priv.field) = { ... }

Returns:

Whether the gte field is set.

getGte

int getGte()

 `gte` requires the field value to be greater than or equal to the specified
 value (exclusive). If the value of `gte` is larger than a specified `lt`
 or `lte`, the range is reversed, and the field value must be outside the
 specified range. If the field value doesn't meet the required conditions,
 an error message is generated.

 ```proto
 message MyUInt32 {
   // value must be greater than or equal to 5 [uint32.gte]
   uint32 value = 1 [(buf.validate.field).uint32.gte = 5];

   // value must be greater than or equal to 5 and less than 10 [uint32.gte_lt]
   uint32 other_value = 2 [(buf.validate.field).uint32 = { gte: 5, lt: 10 }];

   // value must be greater than or equal to 10 or less than 5 [uint32.gte_lt_exclusive]
   uint32 another_value = 3 [(buf.validate.field).uint32 = { gte: 10, lt: 5 }];
 }
 ```
 

uint32 gte = 5 [json_name = "gte", (.buf.validate.priv.field) = { ... }

Returns:

The gte.

getInList

List<Integer> getInList()

 `in` requires the field value to be equal to one of the specified values.
 If the field value isn't one of the specified values, an error message is
 generated.

 ```proto
 message MyUInt32 {
   // value must be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { in: [1, 2, 3] };
 }
 ```
 

repeated uint32 in = 6 [json_name = "in", (.buf.validate.priv.field) = { ... }

Returns:

A list containing the in.

getInCount

int getInCount()

 `in` requires the field value to be equal to one of the specified values.
 If the field value isn't one of the specified values, an error message is
 generated.

 ```proto
 message MyUInt32 {
   // value must be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { in: [1, 2, 3] };
 }
 ```
 

repeated uint32 in = 6 [json_name = "in", (.buf.validate.priv.field) = { ... }

Returns:

The count of in.

getIn

int getIn(int index)

 `in` requires the field value to be equal to one of the specified values.
 If the field value isn't one of the specified values, an error message is
 generated.

 ```proto
 message MyUInt32 {
   // value must be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { in: [1, 2, 3] };
 }
 ```
 

repeated uint32 in = 6 [json_name = "in", (.buf.validate.priv.field) = { ... }

Parameters:

index - The index of the element to return.

Returns:

The in at the given index.

getNotInList

List<Integer> getNotInList()

 `not_in` requires the field value to not be equal to any of the specified
 values. If the field value is one of the specified values, an error
 message is generated.

 ```proto
 message MyUInt32 {
   // value must not be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { not_in: [1, 2, 3] };
 }
 ```
 

repeated uint32 not_in = 7 [json_name = "notIn", (.buf.validate.priv.field) = { ... }

Returns:

A list containing the notIn.

getNotInCount

int getNotInCount()

 `not_in` requires the field value to not be equal to any of the specified
 values. If the field value is one of the specified values, an error
 message is generated.

 ```proto
 message MyUInt32 {
   // value must not be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { not_in: [1, 2, 3] };
 }
 ```
 

repeated uint32 not_in = 7 [json_name = "notIn", (.buf.validate.priv.field) = { ... }

Returns:

The count of notIn.

getNotIn

int getNotIn(int index)

 `not_in` requires the field value to not be equal to any of the specified
 values. If the field value is one of the specified values, an error
 message is generated.

 ```proto
 message MyUInt32 {
   // value must not be in list [1, 2, 3]
   repeated uint32 value = 1 (buf.validate.field).uint32 = { not_in: [1, 2, 3] };
 }
 ```
 

repeated uint32 not_in = 7 [json_name = "notIn", (.buf.validate.priv.field) = { ... }

Parameters:

index - The index of the element to return.

Returns:

The notIn at the given index.

getLessThanCase

UInt32Rules.LessThanCase getLessThanCase()

getGreaterThanCase

UInt32Rules.GreaterThanCase getGreaterThanCase()