Package build.buf.validate

Class Violation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
build.buf.validate.Violation
All Implemented Interfaces:
ViolationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Violation extends com.google.protobuf.GeneratedMessageV3 implements ViolationOrBuilder
 `Violation` represents a single instance where a validation rule, expressed
 as a `Constraint`, was not met. It provides information about the field that
 caused the violation, the specific constraint that wasn't fulfilled, and a
 human-readable error message.

 ```json
 {
   "fieldPath": "bar",
   "constraintId": "foo.bar",
   "message": "bar must be greater than 0"
 }
 ```
Protobuf type buf.validate.Violation
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Violation.Builder
    `Violation` represents a single instance where a validation rule, expressed as a `Constraint`, was not met.

    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
    CONSTRAINT_ID_FIELD_NUMBER
     
    static final int
    FIELD_PATH_FIELD_NUMBER
     
    static final int
    FOR_KEY_FIELD_NUMBER
     
    static final int
    MESSAGE_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)
     
    String
    getConstraintId()
    `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled.
    com.google.protobuf.ByteString
    getConstraintIdBytes()
    `constraint_id` is the unique identifier of the `Constraint` that was not fulfilled.
    static Violation
    getDefaultInstance()
     
    Violation
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getFieldPath()
    `field_path` is a machine-readable identifier that points to the specific field that failed the validation.
    com.google.protobuf.ByteString
    getFieldPathBytes()
    `field_path` is a machine-readable identifier that points to the specific field that failed the validation.
    boolean
    getForKey()
    `for_key` indicates whether the violation was caused by a map key, rather than a value.
    String
    getMessage()
    `message` is a human-readable error message that describes the nature of the violation.
    com.google.protobuf.ByteString
    getMessageBytes()
    `message` is a human-readable error message that describes the nature of the violation.
    com.google.protobuf.Parser<Violation>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Violation.Builder
    newBuilder()
     
    static Violation.Builder
    newBuilder(Violation prototype)
     
    Violation.Builder
    newBuilderForType()
     
    protected Violation.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Violation
    parseDelimitedFrom(InputStream input)
     
    static Violation
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Violation
    parseFrom(byte[] data)
     
    static Violation
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Violation
    parseFrom(com.google.protobuf.ByteString data)
     
    static Violation
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Violation
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Violation
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Violation
    parseFrom(InputStream input)
     
    static Violation
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Violation
    parseFrom(ByteBuffer data)
     
    static Violation
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Violation>
    parser()
     
    Violation.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

    • getFieldPath

      public 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.
      string field_path = 1 [json_name = "fieldPath"];
      Specified by:
      getFieldPath in interface ViolationOrBuilder
      Returns:
      The fieldPath.

    • getFieldPathBytes

      public com.google.protobuf.ByteString getFieldPathBytes()
       `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.
      string field_path = 1 [json_name = "fieldPath"];
      Specified by:
      getFieldPathBytes in interface ViolationOrBuilder
      Returns:
      The bytes for fieldPath.

    • getConstraintId

      public 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.
      string constraint_id = 2 [json_name = "constraintId"];
      Specified by:
      getConstraintId in interface ViolationOrBuilder
      Returns:
      The constraintId.

    • getConstraintIdBytes

      public com.google.protobuf.ByteString getConstraintIdBytes()
       `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.
      string constraint_id = 2 [json_name = "constraintId"];
      Specified by:
      getConstraintIdBytes in interface ViolationOrBuilder
      Returns:
      The bytes for constraintId.

    • getMessage

      public 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.
      string message = 3 [json_name = "message"];
      Specified by:
      getMessage in interface ViolationOrBuilder
      Returns:
      The message.

    • getMessageBytes

      public com.google.protobuf.ByteString getMessageBytes()
       `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.
      string message = 3 [json_name = "message"];
      Specified by:
      getMessageBytes in interface ViolationOrBuilder
      Returns:
      The bytes for message.

    • getForKey

      public boolean getForKey()
       `for_key` indicates whether the violation was caused by a map key, rather than a value.
      bool for_key = 4 [json_name = "forKey"];
      Specified by:
      getForKey in interface ViolationOrBuilder
      Returns:
      The forKey.

    • 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 Violation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Violation.Builder newBuilder()

    • newBuilder

      public static Violation.Builder newBuilder(Violation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Violation getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Violation> 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 Violation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder