build.buf.validate.FieldConstraintsOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of protovalidate Show documentation
Show all versions of protovalidate Show documentation
Protocol Buffer Validation
// Generated by the protocol buffer compiler. DO NOT EDIT!
// NO CHECKED-IN PROTOBUF GENCODE
// source: buf/validate/validate.proto
// Protobuf Java Version: 4.28.1
package build.buf.validate;
public interface FieldConstraintsOrBuilder extends
// @@protoc_insertion_point(interface_extends:buf.validate.FieldConstraints)
com.google.protobuf.MessageOrBuilder {
/**
*
* `cel` is a repeated field used to represent a textual expression
* in the Common Expression Language (CEL) syntax. For more information on
* CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).
*
* ```proto
* message MyMessage {
* // The field `value` must be greater than 42.
* optional int32 value = 1 [(buf.validate.field).cel = {
* id: "my_message.value",
* message: "value must be greater than 42",
* expression: "this > 42",
* }];
* }
* ```
*
*
* repeated .buf.validate.Constraint cel = 23 [json_name = "cel"];
*/
java.util.List
getCelList();
/**
*
* `cel` is a repeated field used to represent a textual expression
* in the Common Expression Language (CEL) syntax. For more information on
* CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).
*
* ```proto
* message MyMessage {
* // The field `value` must be greater than 42.
* optional int32 value = 1 [(buf.validate.field).cel = {
* id: "my_message.value",
* message: "value must be greater than 42",
* expression: "this > 42",
* }];
* }
* ```
*
*
* repeated .buf.validate.Constraint cel = 23 [json_name = "cel"];
*/
build.buf.validate.Constraint getCel(int index);
/**
*
* `cel` is a repeated field used to represent a textual expression
* in the Common Expression Language (CEL) syntax. For more information on
* CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).
*
* ```proto
* message MyMessage {
* // The field `value` must be greater than 42.
* optional int32 value = 1 [(buf.validate.field).cel = {
* id: "my_message.value",
* message: "value must be greater than 42",
* expression: "this > 42",
* }];
* }
* ```
*
*
* repeated .buf.validate.Constraint cel = 23 [json_name = "cel"];
*/
int getCelCount();
/**
*
* `cel` is a repeated field used to represent a textual expression
* in the Common Expression Language (CEL) syntax. For more information on
* CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).
*
* ```proto
* message MyMessage {
* // The field `value` must be greater than 42.
* optional int32 value = 1 [(buf.validate.field).cel = {
* id: "my_message.value",
* message: "value must be greater than 42",
* expression: "this > 42",
* }];
* }
* ```
*
*
* repeated .buf.validate.Constraint cel = 23 [json_name = "cel"];
*/
java.util.List
getCelOrBuilderList();
/**
*
* `cel` is a repeated field used to represent a textual expression
* in the Common Expression Language (CEL) syntax. For more information on
* CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).
*
* ```proto
* message MyMessage {
* // The field `value` must be greater than 42.
* optional int32 value = 1 [(buf.validate.field).cel = {
* id: "my_message.value",
* message: "value must be greater than 42",
* expression: "this > 42",
* }];
* }
* ```
*
*
* repeated .buf.validate.Constraint cel = 23 [json_name = "cel"];
*/
build.buf.validate.ConstraintOrBuilder getCelOrBuilder(
int index);
/**
*
* If `required` is true, the field must be populated. A populated field can be
* described as "serialized in the wire format," which includes:
*
* - the following "nullable" fields must be explicitly set to be considered populated:
* - singular message fields (whose fields may be unpopulated/default values)
* - member fields of a oneof (may be their default value)
* - proto3 optional fields (may be their default value)
* - proto2 scalar fields (both optional and required)
* - proto3 scalar fields must be non-zero to be considered populated
* - repeated and map fields must be non-empty to be considered populated
*
* ```proto
* message MyMessage {
* // The field `value` must be set to a non-null value.
* optional MyOtherMessage value = 1 [(buf.validate.field).required = true];
* }
* ```
*
*
* optional bool required = 25 [json_name = "required"];
* @return Whether the required field is set.
*/
boolean hasRequired();
/**
*
* If `required` is true, the field must be populated. A populated field can be
* described as "serialized in the wire format," which includes:
*
* - the following "nullable" fields must be explicitly set to be considered populated:
* - singular message fields (whose fields may be unpopulated/default values)
* - member fields of a oneof (may be their default value)
* - proto3 optional fields (may be their default value)
* - proto2 scalar fields (both optional and required)
* - proto3 scalar fields must be non-zero to be considered populated
* - repeated and map fields must be non-empty to be considered populated
*
* ```proto
* message MyMessage {
* // The field `value` must be set to a non-null value.
* optional MyOtherMessage value = 1 [(buf.validate.field).required = true];
* }
* ```
*
*
* optional bool required = 25 [json_name = "required"];
* @return The required.
*/
boolean getRequired();
/**
*
* Skip validation on the field if its value matches the specified criteria.
* See Ignore enum for details.
*
* ```proto
* message UpdateRequest {
* // The uri rule only applies if the field is populated and not an empty
* // string.
* optional string url = 1 [
* (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE,
* (buf.validate.field).string.uri = true,
* ];
* }
* ```
*
*
* optional .buf.validate.Ignore ignore = 27 [json_name = "ignore"];
* @return Whether the ignore field is set.
*/
boolean hasIgnore();
/**
*
* Skip validation on the field if its value matches the specified criteria.
* See Ignore enum for details.
*
* ```proto
* message UpdateRequest {
* // The uri rule only applies if the field is populated and not an empty
* // string.
* optional string url = 1 [
* (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE,
* (buf.validate.field).string.uri = true,
* ];
* }
* ```
*
*
* optional .buf.validate.Ignore ignore = 27 [json_name = "ignore"];
* @return The ignore.
*/
build.buf.validate.Ignore getIgnore();
/**
*
* Scalar Field Types
*
*
* .buf.validate.FloatRules float = 1 [json_name = "float"];
* @return Whether the float field is set.
*/
boolean hasFloat();
/**
*
* Scalar Field Types
*
*
* .buf.validate.FloatRules float = 1 [json_name = "float"];
* @return The float.
*/
build.buf.validate.FloatRules getFloat();
/**
*
* Scalar Field Types
*
*
* .buf.validate.FloatRules float = 1 [json_name = "float"];
*/
build.buf.validate.FloatRulesOrBuilder getFloatOrBuilder();
/**
* .buf.validate.DoubleRules double = 2 [json_name = "double"];
* @return Whether the double field is set.
*/
boolean hasDouble();
/**
* .buf.validate.DoubleRules double = 2 [json_name = "double"];
* @return The double.
*/
build.buf.validate.DoubleRules getDouble();
/**
* .buf.validate.DoubleRules double = 2 [json_name = "double"];
*/
build.buf.validate.DoubleRulesOrBuilder getDoubleOrBuilder();
/**
* .buf.validate.Int32Rules int32 = 3 [json_name = "int32"];
* @return Whether the int32 field is set.
*/
boolean hasInt32();
/**
* .buf.validate.Int32Rules int32 = 3 [json_name = "int32"];
* @return The int32.
*/
build.buf.validate.Int32Rules getInt32();
/**
* .buf.validate.Int32Rules int32 = 3 [json_name = "int32"];
*/
build.buf.validate.Int32RulesOrBuilder getInt32OrBuilder();
/**
* .buf.validate.Int64Rules int64 = 4 [json_name = "int64"];
* @return Whether the int64 field is set.
*/
boolean hasInt64();
/**
* .buf.validate.Int64Rules int64 = 4 [json_name = "int64"];
* @return The int64.
*/
build.buf.validate.Int64Rules getInt64();
/**
* .buf.validate.Int64Rules int64 = 4 [json_name = "int64"];
*/
build.buf.validate.Int64RulesOrBuilder getInt64OrBuilder();
/**
* .buf.validate.UInt32Rules uint32 = 5 [json_name = "uint32"];
* @return Whether the uint32 field is set.
*/
boolean hasUint32();
/**
* .buf.validate.UInt32Rules uint32 = 5 [json_name = "uint32"];
* @return The uint32.
*/
build.buf.validate.UInt32Rules getUint32();
/**
* .buf.validate.UInt32Rules uint32 = 5 [json_name = "uint32"];
*/
build.buf.validate.UInt32RulesOrBuilder getUint32OrBuilder();
/**
* .buf.validate.UInt64Rules uint64 = 6 [json_name = "uint64"];
* @return Whether the uint64 field is set.
*/
boolean hasUint64();
/**
* .buf.validate.UInt64Rules uint64 = 6 [json_name = "uint64"];
* @return The uint64.
*/
build.buf.validate.UInt64Rules getUint64();
/**
* .buf.validate.UInt64Rules uint64 = 6 [json_name = "uint64"];
*/
build.buf.validate.UInt64RulesOrBuilder getUint64OrBuilder();
/**
* .buf.validate.SInt32Rules sint32 = 7 [json_name = "sint32"];
* @return Whether the sint32 field is set.
*/
boolean hasSint32();
/**
* .buf.validate.SInt32Rules sint32 = 7 [json_name = "sint32"];
* @return The sint32.
*/
build.buf.validate.SInt32Rules getSint32();
/**
* .buf.validate.SInt32Rules sint32 = 7 [json_name = "sint32"];
*/
build.buf.validate.SInt32RulesOrBuilder getSint32OrBuilder();
/**
* .buf.validate.SInt64Rules sint64 = 8 [json_name = "sint64"];
* @return Whether the sint64 field is set.
*/
boolean hasSint64();
/**
* .buf.validate.SInt64Rules sint64 = 8 [json_name = "sint64"];
* @return The sint64.
*/
build.buf.validate.SInt64Rules getSint64();
/**
* .buf.validate.SInt64Rules sint64 = 8 [json_name = "sint64"];
*/
build.buf.validate.SInt64RulesOrBuilder getSint64OrBuilder();
/**
* .buf.validate.Fixed32Rules fixed32 = 9 [json_name = "fixed32"];
* @return Whether the fixed32 field is set.
*/
boolean hasFixed32();
/**
* .buf.validate.Fixed32Rules fixed32 = 9 [json_name = "fixed32"];
* @return The fixed32.
*/
build.buf.validate.Fixed32Rules getFixed32();
/**
* .buf.validate.Fixed32Rules fixed32 = 9 [json_name = "fixed32"];
*/
build.buf.validate.Fixed32RulesOrBuilder getFixed32OrBuilder();
/**
* .buf.validate.Fixed64Rules fixed64 = 10 [json_name = "fixed64"];
* @return Whether the fixed64 field is set.
*/
boolean hasFixed64();
/**
* .buf.validate.Fixed64Rules fixed64 = 10 [json_name = "fixed64"];
* @return The fixed64.
*/
build.buf.validate.Fixed64Rules getFixed64();
/**
* .buf.validate.Fixed64Rules fixed64 = 10 [json_name = "fixed64"];
*/
build.buf.validate.Fixed64RulesOrBuilder getFixed64OrBuilder();
/**
* .buf.validate.SFixed32Rules sfixed32 = 11 [json_name = "sfixed32"];
* @return Whether the sfixed32 field is set.
*/
boolean hasSfixed32();
/**
* .buf.validate.SFixed32Rules sfixed32 = 11 [json_name = "sfixed32"];
* @return The sfixed32.
*/
build.buf.validate.SFixed32Rules getSfixed32();
/**
* .buf.validate.SFixed32Rules sfixed32 = 11 [json_name = "sfixed32"];
*/
build.buf.validate.SFixed32RulesOrBuilder getSfixed32OrBuilder();
/**
* .buf.validate.SFixed64Rules sfixed64 = 12 [json_name = "sfixed64"];
* @return Whether the sfixed64 field is set.
*/
boolean hasSfixed64();
/**
* .buf.validate.SFixed64Rules sfixed64 = 12 [json_name = "sfixed64"];
* @return The sfixed64.
*/
build.buf.validate.SFixed64Rules getSfixed64();
/**
* .buf.validate.SFixed64Rules sfixed64 = 12 [json_name = "sfixed64"];
*/
build.buf.validate.SFixed64RulesOrBuilder getSfixed64OrBuilder();
/**
* .buf.validate.BoolRules bool = 13 [json_name = "bool"];
* @return Whether the bool field is set.
*/
boolean hasBool();
/**
* .buf.validate.BoolRules bool = 13 [json_name = "bool"];
* @return The bool.
*/
build.buf.validate.BoolRules getBool();
/**
* .buf.validate.BoolRules bool = 13 [json_name = "bool"];
*/
build.buf.validate.BoolRulesOrBuilder getBoolOrBuilder();
/**
* .buf.validate.StringRules string = 14 [json_name = "string"];
* @return Whether the string field is set.
*/
boolean hasString();
/**
* .buf.validate.StringRules string = 14 [json_name = "string"];
* @return The string.
*/
build.buf.validate.StringRules getString();
/**
* .buf.validate.StringRules string = 14 [json_name = "string"];
*/
build.buf.validate.StringRulesOrBuilder getStringOrBuilder();
/**
* .buf.validate.BytesRules bytes = 15 [json_name = "bytes"];
* @return Whether the bytes field is set.
*/
boolean hasBytes();
/**
* .buf.validate.BytesRules bytes = 15 [json_name = "bytes"];
* @return The bytes.
*/
build.buf.validate.BytesRules getBytes();
/**
* .buf.validate.BytesRules bytes = 15 [json_name = "bytes"];
*/
build.buf.validate.BytesRulesOrBuilder getBytesOrBuilder();
/**
*
* Complex Field Types
*
*
* .buf.validate.EnumRules enum = 16 [json_name = "enum"];
* @return Whether the enum field is set.
*/
boolean hasEnum();
/**
*
* Complex Field Types
*
*
* .buf.validate.EnumRules enum = 16 [json_name = "enum"];
* @return The enum.
*/
build.buf.validate.EnumRules getEnum();
/**
*
* Complex Field Types
*
*
* .buf.validate.EnumRules enum = 16 [json_name = "enum"];
*/
build.buf.validate.EnumRulesOrBuilder getEnumOrBuilder();
/**
* .buf.validate.RepeatedRules repeated = 18 [json_name = "repeated"];
* @return Whether the repeated field is set.
*/
boolean hasRepeated();
/**
* .buf.validate.RepeatedRules repeated = 18 [json_name = "repeated"];
* @return The repeated.
*/
build.buf.validate.RepeatedRules getRepeated();
/**
* .buf.validate.RepeatedRules repeated = 18 [json_name = "repeated"];
*/
build.buf.validate.RepeatedRulesOrBuilder getRepeatedOrBuilder();
/**
* .buf.validate.MapRules map = 19 [json_name = "map"];
* @return Whether the map field is set.
*/
boolean hasMap();
/**
* .buf.validate.MapRules map = 19 [json_name = "map"];
* @return The map.
*/
build.buf.validate.MapRules getMap();
/**
* .buf.validate.MapRules map = 19 [json_name = "map"];
*/
build.buf.validate.MapRulesOrBuilder getMapOrBuilder();
/**
*
* Well-Known Field Types
*
*
* .buf.validate.AnyRules any = 20 [json_name = "any"];
* @return Whether the any field is set.
*/
boolean hasAny();
/**
*
* Well-Known Field Types
*
*
* .buf.validate.AnyRules any = 20 [json_name = "any"];
* @return The any.
*/
build.buf.validate.AnyRules getAny();
/**
*
* Well-Known Field Types
*
*
* .buf.validate.AnyRules any = 20 [json_name = "any"];
*/
build.buf.validate.AnyRulesOrBuilder getAnyOrBuilder();
/**
* .buf.validate.DurationRules duration = 21 [json_name = "duration"];
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
* .buf.validate.DurationRules duration = 21 [json_name = "duration"];
* @return The duration.
*/
build.buf.validate.DurationRules getDuration();
/**
* .buf.validate.DurationRules duration = 21 [json_name = "duration"];
*/
build.buf.validate.DurationRulesOrBuilder getDurationOrBuilder();
/**
* .buf.validate.TimestampRules timestamp = 22 [json_name = "timestamp"];
* @return Whether the timestamp field is set.
*/
boolean hasTimestamp();
/**
* .buf.validate.TimestampRules timestamp = 22 [json_name = "timestamp"];
* @return The timestamp.
*/
build.buf.validate.TimestampRules getTimestamp();
/**
* .buf.validate.TimestampRules timestamp = 22 [json_name = "timestamp"];
*/
build.buf.validate.TimestampRulesOrBuilder getTimestampOrBuilder();
/**
*
* DEPRECATED: use ignore=IGNORE_ALWAYS instead. TODO: remove this field pre-v1.
*
*
* optional bool skipped = 24 [json_name = "skipped", deprecated = true];
* @deprecated buf.validate.FieldConstraints.skipped is deprecated.
* See buf/validate/validate.proto;l=245
* @return Whether the skipped field is set.
*/
@java.lang.Deprecated boolean hasSkipped();
/**
*
* DEPRECATED: use ignore=IGNORE_ALWAYS instead. TODO: remove this field pre-v1.
*
*
* optional bool skipped = 24 [json_name = "skipped", deprecated = true];
* @deprecated buf.validate.FieldConstraints.skipped is deprecated.
* See buf/validate/validate.proto;l=245
* @return The skipped.
*/
@java.lang.Deprecated boolean getSkipped();
/**
*
* DEPRECATED: use ignore=IGNORE_IF_UNPOPULATED instead. TODO: remove this field pre-v1.
*
*
* optional bool ignore_empty = 26 [json_name = "ignoreEmpty", deprecated = true];
* @deprecated buf.validate.FieldConstraints.ignore_empty is deprecated.
* See buf/validate/validate.proto;l=247
* @return Whether the ignoreEmpty field is set.
*/
@java.lang.Deprecated boolean hasIgnoreEmpty();
/**
*
* DEPRECATED: use ignore=IGNORE_IF_UNPOPULATED instead. TODO: remove this field pre-v1.
*
*
* optional bool ignore_empty = 26 [json_name = "ignoreEmpty", deprecated = true];
* @deprecated buf.validate.FieldConstraints.ignore_empty is deprecated.
* See buf/validate/validate.proto;l=247
* @return The ignoreEmpty.
*/
@java.lang.Deprecated boolean getIgnoreEmpty();
build.buf.validate.FieldConstraints.TypeCase getTypeCase();
}