Package build.buf.validate

Class Constraint

  • All Implemented Interfaces:
    ConstraintOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class Constraint
extends com.google.protobuf.GeneratedMessage
implements ConstraintOrBuilder
     `Constraint` represents a validation rule written in the Common Expression
 Language (CEL) syntax. Each Constraint includes a unique identifier, an
 optional error message, and the CEL expression to evaluate. For more
 information on CEL, [see our documentation](https://github.com/bufbuild/protovalidate/blob/main/docs/cel.md).

 ```proto
 message Foo {
 option (buf.validate.message).cel = {
 id: "foo.bar"
 message: "bar must be greater than 0"
 expression: "this.bar > 0"
 };
 int32 bar = 1;
 }
 ```
    Protobuf type buf.validate.Constraint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Constraint.Builder
      `Constraint` represents a validation rule written in the Common Expression Language (CEL) syntax.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int EXPRESSION_FIELD_NUMBER  
      static int ID_FIELD_NUMBER  
      static int MESSAGE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessage

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static Constraint getDefaultInstance()  
      Constraint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getExpression()
      `expression` is the actual CEL expression that will be evaluated for validation.
      com.google.protobuf.ByteString getExpressionBytes()
      `expression` is the actual CEL expression that will be evaluated for validation.
      java.lang.String getId()
      `id` is a string that serves as a machine-readable name for this Constraint.
      com.google.protobuf.ByteString getIdBytes()
      `id` is a string that serves as a machine-readable name for this Constraint.
      java.lang.String getMessage()
      `message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.
      com.google.protobuf.ByteString getMessageBytes()
      `message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.
      com.google.protobuf.Parser<Constraint> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Constraint.Builder newBuilder()  
      static Constraint.Builder newBuilder​(Constraint prototype)  
      Constraint.Builder newBuilderForType()  
      protected Constraint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static Constraint parseDelimitedFrom​(java.io.InputStream input)  
      static Constraint parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Constraint parseFrom​(byte[] data)  
      static Constraint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Constraint parseFrom​(com.google.protobuf.ByteString data)  
      static Constraint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Constraint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Constraint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Constraint parseFrom​(java.io.InputStream input)  
      static Constraint parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Constraint parseFrom​(java.nio.ByteBuffer data)  
      static Constraint parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Constraint> parser()  
      Constraint.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        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

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getId

        public java.lang.String getId()
         `id` is a string that serves as a machine-readable name for this Constraint.
 It should be unique within its scope, which could be either a message or a field.
        string id = 1;
        Specified by:
        getId in interface ConstraintOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         `id` is a string that serves as a machine-readable name for this Constraint.
 It should be unique within its scope, which could be either a message or a field.
        string id = 1;
        Specified by:
        getIdBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for id.

      • getMessage

        public java.lang.String getMessage()
         `message` is an optional field that provides a human-readable error message
 for this Constraint when the CEL expression evaluates to false. If a
 non-empty message is provided, any strings resulting from the CEL
 expression evaluation are ignored.
        string message = 2;
        Specified by:
        getMessage in interface ConstraintOrBuilder
        Returns:
        The message.

      • getMessageBytes

        public com.google.protobuf.ByteString getMessageBytes()
         `message` is an optional field that provides a human-readable error message
 for this Constraint when the CEL expression evaluates to false. If a
 non-empty message is provided, any strings resulting from the CEL
 expression evaluation are ignored.
        string message = 2;
        Specified by:
        getMessageBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for message.

      • getExpression

        public java.lang.String getExpression()
         `expression` is the actual CEL expression that will be evaluated for
 validation. This string must resolve to either a boolean or a string
 value. If the expression evaluates to false or a non-empty string, the
 validation is considered failed, and the message is rejected.
        string expression = 3;
        Specified by:
        getExpression in interface ConstraintOrBuilder
        Returns:
        The expression.

      • getExpressionBytes

        public com.google.protobuf.ByteString getExpressionBytes()
         `expression` is the actual CEL expression that will be evaluated for
 validation. This string must resolve to either a boolean or a string
 value. If the expression evaluates to false or a non-empty string, the
 validation is considered failed, and the message is rejected.
        string expression = 3;
        Specified by:
        getExpressionBytes in interface ConstraintOrBuilder
        Returns:
        The bytes for expression.

      • isInitialized

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

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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 Constraint parseFrom​(java.nio.ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Constraint parseFrom​(java.nio.ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Constraint parseFrom​(java.io.InputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Constraint parseFrom​(java.io.InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Constraint parseDelimitedFrom​(java.io.InputStream input)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Constraint parseDelimitedFrom​(java.io.InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Constraint parseFrom​(com.google.protobuf.CodedInputStream input)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Constraint parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Constraint.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • getDefaultInstance

        public static Constraint getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Constraint> 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.GeneratedMessage

      • getDefaultInstanceForType

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