Package build.buf.validate

Interface FieldConstraintsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    FieldConstraints, FieldConstraints.Builder
    public interface FieldConstraintsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getCelList

        java.util.List<Constraint> 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;

      • getCel

        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;

      • getCelCount

        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;

      • getCelOrBuilderList

        java.util.List<? extends ConstraintOrBuilder> 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;

      • getCelOrBuilder

        ConstraintOrBuilder getCelOrBuilder​(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;

      • getSkipped

        boolean getSkipped()
         `skipped` is an optional boolean attribute that specifies that the
 validation rules of this field should not be evaluated. If skipped is set to
 true, any validation rules set for the field will be ignored.

 ```proto
 message MyMessage {
 // The field `value` must not be set.
 optional MyOtherMessage value = 1 [(buf.validate.field).skipped = true];
 }
 ```
        bool skipped = 24;
        Returns:
        The skipped.

      • getRequired

        boolean getRequired()
         If `required` is true, the field must be populated. Field presence can be
 described as "serialized in the wire format," which follows the following rules:

 - the following "nullable" fields must be explicitly set to be considered present:
 - singular message fields (may be their empty value)
 - member fields of a oneof (may be their default value)
 - proto3 optional fields (may be their default value)
 - proto2 scalar fields
 - proto3 scalar fields must be non-zero to be considered present
 - repeated and map fields must be non-empty to be considered present

 ```proto
 message MyMessage {
 // The field `value` must be set to a non-null value.
 optional MyOtherMessage value = 1 [(buf.validate.field).required = true];
 }
 ```
        bool required = 25;
        Returns:
        The required.

      • getIgnoreEmpty

        boolean getIgnoreEmpty()
         If `ignore_empty` is true and applied to a non-nullable field (see
 `required` for more details), validation is skipped on the field if it is
 the default or empty value. Adding `ignore_empty` to a "nullable" field is
 a noop as these unset fields already skip validation (with the exception
 of `required`).

 ```proto
 message MyRepeated {
 // The field `value` min_len rule is only applied if the field isn't empty.
 repeated string value = 1 [
 (buf.validate.field).ignore_empty = true,
 (buf.validate.field).min_len = 5
 ];
 }
 ```
        bool ignore_empty = 26;
        Returns:
        The ignoreEmpty.

      • hasFloat

        boolean hasFloat()
         Scalar Field Types
        .buf.validate.FloatRules float = 1;
        Returns:
        Whether the float field is set.

      • getFloat

        FloatRules getFloat()
         Scalar Field Types
        .buf.validate.FloatRules float = 1;
        Returns:
        The float.

      • getFloatOrBuilder

        FloatRulesOrBuilder getFloatOrBuilder()
         Scalar Field Types
        .buf.validate.FloatRules float = 1;

      • hasDouble

        boolean hasDouble()
        .buf.validate.DoubleRules double = 2;
        Returns:
        Whether the double field is set.

      • getDouble

        DoubleRules getDouble()
        .buf.validate.DoubleRules double = 2;
        Returns:
        The double.

      • getDoubleOrBuilder

        DoubleRulesOrBuilder getDoubleOrBuilder()
        .buf.validate.DoubleRules double = 2;

      • hasInt32

        boolean hasInt32()
        .buf.validate.Int32Rules int32 = 3;
        Returns:
        Whether the int32 field is set.

      • getInt32

        Int32Rules getInt32()
        .buf.validate.Int32Rules int32 = 3;
        Returns:
        The int32.

      • getInt32OrBuilder

        Int32RulesOrBuilder getInt32OrBuilder()
        .buf.validate.Int32Rules int32 = 3;

      • hasInt64

        boolean hasInt64()
        .buf.validate.Int64Rules int64 = 4;
        Returns:
        Whether the int64 field is set.

      • getInt64

        Int64Rules getInt64()
        .buf.validate.Int64Rules int64 = 4;
        Returns:
        The int64.

      • getInt64OrBuilder

        Int64RulesOrBuilder getInt64OrBuilder()
        .buf.validate.Int64Rules int64 = 4;

      • hasUint32

        boolean hasUint32()
        .buf.validate.UInt32Rules uint32 = 5;
        Returns:
        Whether the uint32 field is set.

      • getUint32

        UInt32Rules getUint32()
        .buf.validate.UInt32Rules uint32 = 5;
        Returns:
        The uint32.

      • getUint32OrBuilder

        UInt32RulesOrBuilder getUint32OrBuilder()
        .buf.validate.UInt32Rules uint32 = 5;

      • hasUint64

        boolean hasUint64()
        .buf.validate.UInt64Rules uint64 = 6;
        Returns:
        Whether the uint64 field is set.

      • getUint64

        UInt64Rules getUint64()
        .buf.validate.UInt64Rules uint64 = 6;
        Returns:
        The uint64.

      • getUint64OrBuilder

        UInt64RulesOrBuilder getUint64OrBuilder()
        .buf.validate.UInt64Rules uint64 = 6;

      • hasSint32

        boolean hasSint32()
        .buf.validate.SInt32Rules sint32 = 7;
        Returns:
        Whether the sint32 field is set.

      • getSint32

        SInt32Rules getSint32()
        .buf.validate.SInt32Rules sint32 = 7;
        Returns:
        The sint32.

      • getSint32OrBuilder

        SInt32RulesOrBuilder getSint32OrBuilder()
        .buf.validate.SInt32Rules sint32 = 7;

      • hasSint64

        boolean hasSint64()
        .buf.validate.SInt64Rules sint64 = 8;
        Returns:
        Whether the sint64 field is set.

      • getSint64

        SInt64Rules getSint64()
        .buf.validate.SInt64Rules sint64 = 8;
        Returns:
        The sint64.

      • getSint64OrBuilder

        SInt64RulesOrBuilder getSint64OrBuilder()
        .buf.validate.SInt64Rules sint64 = 8;

      • hasFixed32

        boolean hasFixed32()
        .buf.validate.Fixed32Rules fixed32 = 9;
        Returns:
        Whether the fixed32 field is set.

      • getFixed32

        Fixed32Rules getFixed32()
        .buf.validate.Fixed32Rules fixed32 = 9;
        Returns:
        The fixed32.

      • getFixed32OrBuilder

        Fixed32RulesOrBuilder getFixed32OrBuilder()
        .buf.validate.Fixed32Rules fixed32 = 9;

      • hasFixed64

        boolean hasFixed64()
        .buf.validate.Fixed64Rules fixed64 = 10;
        Returns:
        Whether the fixed64 field is set.

      • getFixed64

        Fixed64Rules getFixed64()
        .buf.validate.Fixed64Rules fixed64 = 10;
        Returns:
        The fixed64.

      • getFixed64OrBuilder

        Fixed64RulesOrBuilder getFixed64OrBuilder()
        .buf.validate.Fixed64Rules fixed64 = 10;

      • hasSfixed32

        boolean hasSfixed32()
        .buf.validate.SFixed32Rules sfixed32 = 11;
        Returns:
        Whether the sfixed32 field is set.

      • getSfixed32

        SFixed32Rules getSfixed32()
        .buf.validate.SFixed32Rules sfixed32 = 11;
        Returns:
        The sfixed32.

      • getSfixed32OrBuilder

        SFixed32RulesOrBuilder getSfixed32OrBuilder()
        .buf.validate.SFixed32Rules sfixed32 = 11;

      • hasSfixed64

        boolean hasSfixed64()
        .buf.validate.SFixed64Rules sfixed64 = 12;
        Returns:
        Whether the sfixed64 field is set.

      • getSfixed64

        SFixed64Rules getSfixed64()
        .buf.validate.SFixed64Rules sfixed64 = 12;
        Returns:
        The sfixed64.

      • getSfixed64OrBuilder

        SFixed64RulesOrBuilder getSfixed64OrBuilder()
        .buf.validate.SFixed64Rules sfixed64 = 12;

      • hasBool

        boolean hasBool()
        .buf.validate.BoolRules bool = 13;
        Returns:
        Whether the bool field is set.

      • getBool

        BoolRules getBool()
        .buf.validate.BoolRules bool = 13;
        Returns:
        The bool.

      • getBoolOrBuilder

        BoolRulesOrBuilder getBoolOrBuilder()
        .buf.validate.BoolRules bool = 13;

      • hasString

        boolean hasString()
        .buf.validate.StringRules string = 14;
        Returns:
        Whether the string field is set.

      • getString

        StringRules getString()
        .buf.validate.StringRules string = 14;
        Returns:
        The string.

      • getStringOrBuilder

        StringRulesOrBuilder getStringOrBuilder()
        .buf.validate.StringRules string = 14;

      • hasBytes

        boolean hasBytes()
        .buf.validate.BytesRules bytes = 15;
        Returns:
        Whether the bytes field is set.

      • getBytes

        BytesRules getBytes()
        .buf.validate.BytesRules bytes = 15;
        Returns:
        The bytes.

      • getBytesOrBuilder

        BytesRulesOrBuilder getBytesOrBuilder()
        .buf.validate.BytesRules bytes = 15;

      • hasEnum

        boolean hasEnum()
         Complex Field Types
        .buf.validate.EnumRules enum = 16;
        Returns:
        Whether the enum field is set.

      • getEnum

        EnumRules getEnum()
         Complex Field Types
        .buf.validate.EnumRules enum = 16;
        Returns:
        The enum.

      • getEnumOrBuilder

        EnumRulesOrBuilder getEnumOrBuilder()
         Complex Field Types
        .buf.validate.EnumRules enum = 16;

      • hasRepeated

        boolean hasRepeated()
        .buf.validate.RepeatedRules repeated = 18;
        Returns:
        Whether the repeated field is set.

      • getRepeated

        RepeatedRules getRepeated()
        .buf.validate.RepeatedRules repeated = 18;
        Returns:
        The repeated.

      • getRepeatedOrBuilder

        RepeatedRulesOrBuilder getRepeatedOrBuilder()
        .buf.validate.RepeatedRules repeated = 18;

      • hasMap

        boolean hasMap()
        .buf.validate.MapRules map = 19;
        Returns:
        Whether the map field is set.

      • getMap

        MapRules getMap()
        .buf.validate.MapRules map = 19;
        Returns:
        The map.

      • getMapOrBuilder

        MapRulesOrBuilder getMapOrBuilder()
        .buf.validate.MapRules map = 19;

      • hasAny

        boolean hasAny()
         Well-Known Field Types
        .buf.validate.AnyRules any = 20;
        Returns:
        Whether the any field is set.

      • getAny

        AnyRules getAny()
         Well-Known Field Types
        .buf.validate.AnyRules any = 20;
        Returns:
        The any.

      • getAnyOrBuilder

        AnyRulesOrBuilder getAnyOrBuilder()
         Well-Known Field Types
        .buf.validate.AnyRules any = 20;

      • hasDuration

        boolean hasDuration()
        .buf.validate.DurationRules duration = 21;
        Returns:
        Whether the duration field is set.

      • getDuration

        DurationRules getDuration()
        .buf.validate.DurationRules duration = 21;
        Returns:
        The duration.

      • getDurationOrBuilder

        DurationRulesOrBuilder getDurationOrBuilder()
        .buf.validate.DurationRules duration = 21;

      • hasTimestamp

        boolean hasTimestamp()
        .buf.validate.TimestampRules timestamp = 22;
        Returns:
        Whether the timestamp field is set.

      • getTimestamp

        TimestampRules getTimestamp()
        .buf.validate.TimestampRules timestamp = 22;
        Returns:
        The timestamp.

      • getTimestampOrBuilder

        TimestampRulesOrBuilder getTimestampOrBuilder()
        .buf.validate.TimestampRules timestamp = 22;