Package build.buf.validate
Class Constraint.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
build.buf.validate.Constraint.Builder
- All Implemented Interfaces:
ConstraintOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- Constraint
public static final class Constraint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
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-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()`expression` is the actual CEL expression that will be evaluated for validation.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearId()`id` is a string that serves as a machine-readable name for this Constraint.`message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) clone()static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptor`expression` is the actual CEL expression that will be evaluated for validation.com.google.protobuf.ByteString`expression` is the actual CEL expression that will be evaluated for validation.getId()`id` is a string that serves as a machine-readable name for this Constraint.com.google.protobuf.ByteString`id` is a string that serves as a machine-readable name for this Constraint.`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`message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeFrom(Constraint other) mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) final Constraint.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setExpression(String value) `expression` is the actual CEL expression that will be evaluated for validation.setExpressionBytes(com.google.protobuf.ByteString value) `expression` is the actual CEL expression that will be evaluated for validation.`id` is a string that serves as a machine-readable name for this Constraint.setIdBytes(com.google.protobuf.ByteString value) `id` is a string that serves as a machine-readable name for this Constraint.setMessage(String value) `message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.setMessageBytes(com.google.protobuf.ByteString value) `message` is an optional field that provides a human-readable error message for this Constraint when the CEL expression evaluates to false.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) final Constraint.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
setField
public Constraint.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
setRepeatedField
public Constraint.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
addRepeatedField
public Constraint.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Constraint.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
mergeFrom
public Constraint.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Constraint.Builder>- Throws:
IOException
-
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 [json_name = "id"];- Specified by:
getIdin interfaceConstraintOrBuilder- 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 [json_name = "id"];- Specified by:
getIdBytesin interfaceConstraintOrBuilder- Returns:
- The bytes for id.
-
setId
`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 [json_name = "id"];- Parameters:
value- The id to set.- Returns:
- This builder for chaining.
-
clearId
`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 [json_name = "id"];- Returns:
- This builder for chaining.
-
setIdBytes
`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 [json_name = "id"];- Parameters:
value- The bytes for id to set.- Returns:
- This builder for chaining.
-
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 [json_name = "message"];- Specified by:
getMessagein interfaceConstraintOrBuilder- 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 [json_name = "message"];- Specified by:
getMessageBytesin interfaceConstraintOrBuilder- Returns:
- The bytes for message.
-
setMessage
`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 [json_name = "message"];- Parameters:
value- The message to set.- Returns:
- This builder for chaining.
-
clearMessage
`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 [json_name = "message"];- Returns:
- This builder for chaining.
-
setMessageBytes
`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 [json_name = "message"];- Parameters:
value- The bytes for message to set.- Returns:
- This builder for chaining.
-
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 [json_name = "expression"];- Specified by:
getExpressionin interfaceConstraintOrBuilder- 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 [json_name = "expression"];- Specified by:
getExpressionBytesin interfaceConstraintOrBuilder- Returns:
- The bytes for expression.
-
setExpression
`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 [json_name = "expression"];- Parameters:
value- The expression to set.- Returns:
- This builder for chaining.
-
clearExpression
`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 [json_name = "expression"];- Returns:
- This builder for chaining.
-
setExpressionBytes
`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 [json_name = "expression"];- Parameters:
value- The bytes for expression to set.- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-
mergeUnknownFields
public final Constraint.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<Constraint.Builder>
-