Package com.google.rpc

Class BadRequest.FieldViolation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.rpc.BadRequest.FieldViolation
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BadRequest.FieldViolationOrBuilder, Serializable
Enclosing class:
BadRequest
public static final class BadRequest.FieldViolation extends com.google.protobuf.GeneratedMessage implements BadRequest.FieldViolationOrBuilder
 A message type used to describe a single bad request field.
Protobuf type google.rpc.BadRequest.FieldViolation
See Also:

  • Field Details

    • FIELD_FIELD_NUMBER

      public static final int FIELD_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • REASON_FIELD_NUMBER

      public static final int REASON_FIELD_NUMBER
      See Also:

    • LOCALIZED_MESSAGE_FIELD_NUMBER

      public static final int LOCALIZED_MESSAGE_FIELD_NUMBER
      See Also:

  • Method Details

    • 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

    • getField

      public String getField()
       A path that leads to a field in the request body. The value will be a
 sequence of dot-separated identifiers that identify a protocol buffer
 field.

 Consider the following:

 message CreateContactRequest {
 message EmailAddress {
 enum Type {
 TYPE_UNSPECIFIED = 0;
 HOME = 1;
 WORK = 2;
 }

 optional string email = 1;
 repeated EmailType type = 2;
 }

 string full_name = 1;
 repeated EmailAddress email_addresses = 2;
 }

 In this example, in proto `field` could take one of the following values:

 * `full_name` for a violation in the `full_name` value
 * `email_addresses[1].email` for a violation in the `email` field of the
 first `email_addresses` message
 * `email_addresses[3].type[2]` for a violation in the second `type`
 value in the third `email_addresses` message.

 In JSON, the same values are represented as:

 * `fullName` for a violation in the `fullName` value
 * `emailAddresses[1].email` for a violation in the `email` field of the
 first `emailAddresses` message
 * `emailAddresses[3].type[2]` for a violation in the second `type`
 value in the third `emailAddresses` message.
      string field = 1;
      Specified by:
      getField in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The field.

    • getFieldBytes

      public com.google.protobuf.ByteString getFieldBytes()
       A path that leads to a field in the request body. The value will be a
 sequence of dot-separated identifiers that identify a protocol buffer
 field.

 Consider the following:

 message CreateContactRequest {
 message EmailAddress {
 enum Type {
 TYPE_UNSPECIFIED = 0;
 HOME = 1;
 WORK = 2;
 }

 optional string email = 1;
 repeated EmailType type = 2;
 }

 string full_name = 1;
 repeated EmailAddress email_addresses = 2;
 }

 In this example, in proto `field` could take one of the following values:

 * `full_name` for a violation in the `full_name` value
 * `email_addresses[1].email` for a violation in the `email` field of the
 first `email_addresses` message
 * `email_addresses[3].type[2]` for a violation in the second `type`
 value in the third `email_addresses` message.

 In JSON, the same values are represented as:

 * `fullName` for a violation in the `fullName` value
 * `emailAddresses[1].email` for a violation in the `email` field of the
 first `emailAddresses` message
 * `emailAddresses[3].type[2]` for a violation in the second `type`
 value in the third `emailAddresses` message.
      string field = 1;
      Specified by:
      getFieldBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for field.

    • getDescription

      public String getDescription()
       A description of why the request element is bad.
      string description = 2;
      Specified by:
      getDescription in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       A description of why the request element is bad.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for description.

    • getReason

      public String getReason()
       The reason of the field-level error. This is a constant value that
 identifies the proximate cause of the field-level error. It should
 uniquely identify the type of the FieldViolation within the scope of the
 google.rpc.ErrorInfo.domain. This should be at most 63
 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,
 which represents UPPER_SNAKE_CASE.
      string reason = 3;
      Specified by:
      getReason in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The reason.

    • getReasonBytes

      public com.google.protobuf.ByteString getReasonBytes()
       The reason of the field-level error. This is a constant value that
 identifies the proximate cause of the field-level error. It should
 uniquely identify the type of the FieldViolation within the scope of the
 google.rpc.ErrorInfo.domain. This should be at most 63
 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`,
 which represents UPPER_SNAKE_CASE.
      string reason = 3;
      Specified by:
      getReasonBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for reason.

    • hasLocalizedMessage

      public boolean hasLocalizedMessage()
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4;
      Specified by:
      hasLocalizedMessage in interface BadRequest.FieldViolationOrBuilder
      Returns:
      Whether the localizedMessage field is set.

    • getLocalizedMessage

      public LocalizedMessage getLocalizedMessage()
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4;
      Specified by:
      getLocalizedMessage in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The localizedMessage.

    • getLocalizedMessageOrBuilder

      public LocalizedMessageOrBuilder getLocalizedMessageOrBuilder()
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4;
      Specified by:
      getLocalizedMessageOrBuilder in interface BadRequest.FieldViolationOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      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(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 BadRequest.FieldViolation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BadRequest.FieldViolation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static BadRequest.FieldViolation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BadRequest.FieldViolation.Builder newBuilder()

    • newBuilder

      public static BadRequest.FieldViolation.Builder newBuilder(BadRequest.FieldViolation prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BadRequest.FieldViolation getDefaultInstance()

    • parser

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

    • getParserForType

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