Package build.buf.validate

Interface UInt64RulesOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

UInt64Rules, UInt64Rules.Builder

public interface UInt64RulesOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
long	getConst()	`const` requires the field value to exactly match the specified value.
UInt64Rules.GreaterThanCase	getGreaterThanCase()
long	getGt()	`gt` requires the field value to be greater than the specified value (exclusive).
long	getGte()	`gte` requires the field value to be greater than or equal to the specified value (exclusive).
long	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<Long>	getInList()	`in` requires the field value to be equal to one of the specified values.
UInt64Rules.LessThanCase	getLessThanCase()
long	getLt()	`lt` requires the field value to be less than the specified value (field < value).
long	getLte()	`lte` requires the field value to be less than or equal to the specified value (field <= value).
long	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<Long>	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.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

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

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

Returns:

Whether the const field is set.

getConst

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

optional uint64 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 MyUInt64 {
   // value must be less than 10
   uint64 value = 1 [(buf.validate.field).uint64.lt = 10];
 }
 ```
 

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

Returns:

Whether the lt field is set.

getLt

long 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 MyUInt64 {
   // value must be less than 10
   uint64 value = 1 [(buf.validate.field).uint64.lt = 10];
 }
 ```
 

uint64 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 MyUInt64 {
   // value must be less than or equal to 10
   uint64 value = 1 [(buf.validate.field).uint64.lte = 10];
 }
 ```
 

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

Returns:

Whether the lte field is set.

getLte

long 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 MyUInt64 {
   // value must be less than or equal to 10
   uint64 value = 1 [(buf.validate.field).uint64.lte = 10];
 }
 ```
 

uint64 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 MyUInt64 {
   // value must be greater than 5 [uint64.gt]
   uint64 value = 1 [(buf.validate.field).uint64.gt = 5];

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

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

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

Returns:

Whether the gt field is set.

getGt

long 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 MyUInt64 {
   // value must be greater than 5 [uint64.gt]
   uint64 value = 1 [(buf.validate.field).uint64.gt = 5];

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

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

uint64 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 MyUInt64 {
   // value must be greater than or equal to 5 [uint64.gte]
   uint64 value = 1 [(buf.validate.field).uint64.gte = 5];

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

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

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

Returns:

Whether the gte field is set.

getGte

long 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 MyUInt64 {
   // value must be greater than or equal to 5 [uint64.gte]
   uint64 value = 1 [(buf.validate.field).uint64.gte = 5];

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

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

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

Returns:

The gte.

getInList

List<Long> 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 MyUInt64 {
   // value must be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { in: [1, 2, 3] };
 }
 ```
 

repeated uint64 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 MyUInt64 {
   // value must be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { in: [1, 2, 3] };
 }
 ```
 

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

Returns:

The count of in.

getIn

long 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 MyUInt64 {
   // value must be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { in: [1, 2, 3] };
 }
 ```
 

repeated uint64 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<Long> 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 MyUInt64 {
   // value must not be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { not_in: [1, 2, 3] };
 }
 ```
 

repeated uint64 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 MyUInt64 {
   // value must not be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { not_in: [1, 2, 3] };
 }
 ```
 

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

Returns:

The count of notIn.

getNotIn

long 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 MyUInt64 {
   // value must not be in list [1, 2, 3]
   repeated uint64 value = 1 (buf.validate.field).uint64 = { not_in: [1, 2, 3] };
 }
 ```
 

repeated uint64 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

UInt64Rules.LessThanCase getLessThanCase()

getGreaterThanCase

UInt64Rules.GreaterThanCase getGreaterThanCase()