Package build.buf.validate

Class MessageConstraints

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
build.buf.validate.MessageConstraints
All Implemented Interfaces:
MessageConstraintsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class MessageConstraints extends com.google.protobuf.GeneratedMessageV3 implements MessageConstraintsOrBuilder
 MessageConstraints represents validation rules that are applied to the entire message.
 It includes disabling options and a list of Constraint messages representing Common Expression Language (CEL) validation rules.
Protobuf type buf.validate.MessageConstraints
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MessageConstraints.Builder
    MessageConstraints represents validation rules that are applied to the entire message.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CEL_FIELD_NUMBER
     
    static final int
    DISABLED_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    Constraint
    getCel(int index)
    cel is a repeated field of type Constraint.
    int
    getCelCount()
    cel is a repeated field of type Constraint.
    List<Constraint>
    getCelList()
    cel is a repeated field of type Constraint.
    ConstraintOrBuilder
    getCelOrBuilder(int index)
    cel is a repeated field of type Constraint.
    List<? extends ConstraintOrBuilder>
    getCelOrBuilderList()
    cel is a repeated field of type Constraint.
    static MessageConstraints
    getDefaultInstance()
     
    MessageConstraints
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisabled()
    disabled is a boolean flag that, when set to true, nullifies any validation rules for this message.
    com.google.protobuf.Parser<MessageConstraints>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasDisabled()
    disabled is a boolean flag that, when set to true, nullifies any validation rules for this message.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MessageConstraints.Builder
    newBuilder()
     
    static MessageConstraints.Builder
    newBuilder(MessageConstraints prototype)
     
    MessageConstraints.Builder
    newBuilderForType()
     
    protected MessageConstraints.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static MessageConstraints
    parseDelimitedFrom(InputStream input)
     
    static MessageConstraints
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MessageConstraints
    parseFrom(byte[] data)
     
    static MessageConstraints
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MessageConstraints
    parseFrom(com.google.protobuf.ByteString data)
     
    static MessageConstraints
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MessageConstraints
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MessageConstraints
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MessageConstraints
    parseFrom(InputStream input)
     
    static MessageConstraints
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MessageConstraints
    parseFrom(ByteBuffer data)
     
    static MessageConstraints
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MessageConstraints>
    parser()
     
    MessageConstraints.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasDisabled

      public boolean hasDisabled()
       disabled is a boolean flag that, when set to true, nullifies any validation rules for this message.
 This includes any fields within the message that would otherwise support validation.

 ```proto
 message MyMessage {
   // validation will be bypassed for this message
   option (buf.validate.message).disabled = true;
 }
 ```
      optional bool disabled = 1 [json_name = "disabled"];
      Specified by:
      hasDisabled in interface MessageConstraintsOrBuilder
      Returns:
      Whether the disabled field is set.

    • getDisabled

      public boolean getDisabled()
       disabled is a boolean flag that, when set to true, nullifies any validation rules for this message.
 This includes any fields within the message that would otherwise support validation.

 ```proto
 message MyMessage {
   // validation will be bypassed for this message
   option (buf.validate.message).disabled = true;
 }
 ```
      optional bool disabled = 1 [json_name = "disabled"];
      Specified by:
      getDisabled in interface MessageConstraintsOrBuilder
      Returns:
      The disabled.

    • getCelList

      public List<Constraint> getCelList()
       cel is a repeated field of type Constraint. Each Constraint specifies a validation rule to be applied to this message.
 These constraints are written in 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 `foo` must be greater than 42.
  option (buf.validate.message).cel = {
    id: "my_message.value",
    message: "value must be greater than 42",
    expression: "this.foo > 42",
  };
  optional int32 foo = 1;
}
```
      repeated .buf.validate.Constraint cel = 3 [json_name = "cel"];
      Specified by:
      getCelList in interface MessageConstraintsOrBuilder

    • getCelOrBuilderList

      public List<? extends ConstraintOrBuilder> getCelOrBuilderList()
       cel is a repeated field of type Constraint. Each Constraint specifies a validation rule to be applied to this message.
 These constraints are written in 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 `foo` must be greater than 42.
  option (buf.validate.message).cel = {
    id: "my_message.value",
    message: "value must be greater than 42",
    expression: "this.foo > 42",
  };
  optional int32 foo = 1;
}
```
      repeated .buf.validate.Constraint cel = 3 [json_name = "cel"];
      Specified by:
      getCelOrBuilderList in interface MessageConstraintsOrBuilder

    • getCelCount

      public int getCelCount()
       cel is a repeated field of type Constraint. Each Constraint specifies a validation rule to be applied to this message.
 These constraints are written in 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 `foo` must be greater than 42.
  option (buf.validate.message).cel = {
    id: "my_message.value",
    message: "value must be greater than 42",
    expression: "this.foo > 42",
  };
  optional int32 foo = 1;
}
```
      repeated .buf.validate.Constraint cel = 3 [json_name = "cel"];
      Specified by:
      getCelCount in interface MessageConstraintsOrBuilder

    • getCel

      public Constraint getCel(int index)
       cel is a repeated field of type Constraint. Each Constraint specifies a validation rule to be applied to this message.
 These constraints are written in 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 `foo` must be greater than 42.
  option (buf.validate.message).cel = {
    id: "my_message.value",
    message: "value must be greater than 42",
    expression: "this.foo > 42",
  };
  optional int32 foo = 1;
}
```
      repeated .buf.validate.Constraint cel = 3 [json_name = "cel"];
      Specified by:
      getCel in interface MessageConstraintsOrBuilder

    • getCelOrBuilder

      public ConstraintOrBuilder getCelOrBuilder(int index)
       cel is a repeated field of type Constraint. Each Constraint specifies a validation rule to be applied to this message.
 These constraints are written in 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 `foo` must be greater than 42.
  option (buf.validate.message).cel = {
    id: "my_message.value",
    message: "value must be greater than 42",
    expression: "this.foo > 42",
  };
  optional int32 foo = 1;
}
```
      repeated .buf.validate.Constraint cel = 3 [json_name = "cel"];
      Specified by:
      getCelOrBuilder in interface MessageConstraintsOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MessageConstraints parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MessageConstraints parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MessageConstraints parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MessageConstraints parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MessageConstraints parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MessageConstraints parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MessageConstraints parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MessageConstraints.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MessageConstraints.Builder newBuilder()

    • newBuilder

      public static MessageConstraints.Builder newBuilder(MessageConstraints prototype)

    • toBuilder

      public MessageConstraints.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MessageConstraints.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static MessageConstraints getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MessageConstraints> parser()

    • getParserForType

      public com.google.protobuf.Parser<MessageConstraints> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public MessageConstraints getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder