build.buf.validate.ViolationOrBuilder 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 ViolationOrBuilder extends
// @@protoc_insertion_point(interface_extends:buf.validate.Violation)
com.google.protobuf.MessageOrBuilder {
/**
*
* `field_path` is a machine-readable identifier that points to the specific field that failed the validation.
* This could be a nested field, in which case the path will include all the parent fields leading to the actual field that caused the violation.
*
*
* optional string field_path = 1 [json_name = "fieldPath"];
* @return Whether the fieldPath field is set.
*/
boolean hasFieldPath();
/**
*
* `field_path` is a machine-readable identifier that points to the specific field that failed the validation.
* This could be a nested field, in which case the path will include all the parent fields leading to the actual field that caused the violation.
*
*
* optional string field_path = 1 [json_name = "fieldPath"];
* @return The fieldPath.
*/
java.lang.String getFieldPath();
/**
*
* `field_path` is a machine-readable identifier that points to the specific field that failed the validation.
* This could be a nested field, in which case the path will include all the parent fields leading to the actual field that caused the violation.
*
*
* optional string field_path = 1 [json_name = "fieldPath"];
* @return The bytes for fieldPath.
*/
com.google.protobuf.ByteString
getFieldPathBytes();
/**
*
* `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled.
* This is the same `id` that was specified in the `Constraint` message, allowing easy tracing of which rule was violated.
*
*
* optional string constraint_id = 2 [json_name = "constraintId"];
* @return Whether the constraintId field is set.
*/
boolean hasConstraintId();
/**
*
* `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled.
* This is the same `id` that was specified in the `Constraint` message, allowing easy tracing of which rule was violated.
*
*
* optional string constraint_id = 2 [json_name = "constraintId"];
* @return The constraintId.
*/
java.lang.String getConstraintId();
/**
*
* `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled.
* This is the same `id` that was specified in the `Constraint` message, allowing easy tracing of which rule was violated.
*
*
* optional string constraint_id = 2 [json_name = "constraintId"];
* @return The bytes for constraintId.
*/
com.google.protobuf.ByteString
getConstraintIdBytes();
/**
*
* `message` is a human-readable error message that describes the nature of the violation.
* This can be the default error message from the violated `Constraint`, or it can be a custom message that gives more context about the violation.
*
*
* optional string message = 3 [json_name = "message"];
* @return Whether the message field is set.
*/
boolean hasMessage();
/**
*
* `message` is a human-readable error message that describes the nature of the violation.
* This can be the default error message from the violated `Constraint`, or it can be a custom message that gives more context about the violation.
*
*
* optional string message = 3 [json_name = "message"];
* @return The message.
*/
java.lang.String getMessage();
/**
*
* `message` is a human-readable error message that describes the nature of the violation.
* This can be the default error message from the violated `Constraint`, or it can be a custom message that gives more context about the violation.
*
*
* optional string message = 3 [json_name = "message"];
* @return The bytes for message.
*/
com.google.protobuf.ByteString
getMessageBytes();
/**
*
* `for_key` indicates whether the violation was caused by a map key, rather than a value.
*
*
* optional bool for_key = 4 [json_name = "forKey"];
* @return Whether the forKey field is set.
*/
boolean hasForKey();
/**
*
* `for_key` indicates whether the violation was caused by a map key, rather than a value.
*
*
* optional bool for_key = 4 [json_name = "forKey"];
* @return The forKey.
*/
boolean getForKey();
}