Package com.google.rpc

Class BadRequest.FieldViolation.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<BadRequest.FieldViolation,BadRequest.FieldViolation.Builder>
com.google.rpc.BadRequest.FieldViolation.Builder
All Implemented Interfaces:
com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, BadRequest.FieldViolationOrBuilder, Cloneable
Enclosing class:
BadRequest.FieldViolation
public static final class BadRequest.FieldViolation.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<BadRequest.FieldViolation,BadRequest.FieldViolation.Builder> implements BadRequest.FieldViolationOrBuilder
 A message type used to describe a single bad request field.
Protobuf type google.rpc.BadRequest.FieldViolation

  • Method Details

    • 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 [json_name = "field"];
      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 [json_name = "field"];
      Specified by:
      getFieldBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for field.

    • setField

      public BadRequest.FieldViolation.Builder setField(String value)
       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 [json_name = "field"];
      Parameters:
      value - The field to set.
      Returns:
      This builder for chaining.

    • clearField

      public BadRequest.FieldViolation.Builder clearField()
       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 [json_name = "field"];
      Returns:
      This builder for chaining.

    • setFieldBytes

      public BadRequest.FieldViolation.Builder setFieldBytes(com.google.protobuf.ByteString value)
       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 [json_name = "field"];
      Parameters:
      value - The bytes for field to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       A description of why the request element is bad.
      string description = 2 [json_name = "description"];
      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 [json_name = "description"];
      Specified by:
      getDescriptionBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public BadRequest.FieldViolation.Builder setDescription(String value)
       A description of why the request element is bad.
      string description = 2 [json_name = "description"];
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public BadRequest.FieldViolation.Builder clearDescription()
       A description of why the request element is bad.
      string description = 2 [json_name = "description"];
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public BadRequest.FieldViolation.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       A description of why the request element is bad.
      string description = 2 [json_name = "description"];
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "reason"];
      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 [json_name = "reason"];
      Specified by:
      getReasonBytes in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The bytes for reason.

    • setReason

      public BadRequest.FieldViolation.Builder setReason(String value)
       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 [json_name = "reason"];
      Parameters:
      value - The reason to set.
      Returns:
      This builder for chaining.

    • clearReason

      public BadRequest.FieldViolation.Builder clearReason()
       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 [json_name = "reason"];
      Returns:
      This builder for chaining.

    • setReasonBytes

      public BadRequest.FieldViolation.Builder setReasonBytes(com.google.protobuf.ByteString value)
       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 [json_name = "reason"];
      Parameters:
      value - The bytes for reason to set.
      Returns:
      This builder for chaining.

    • 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 [json_name = "localizedMessage"];
      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 [json_name = "localizedMessage"];
      Specified by:
      getLocalizedMessage in interface BadRequest.FieldViolationOrBuilder
      Returns:
      The localizedMessage.

    • setLocalizedMessage

      public BadRequest.FieldViolation.Builder setLocalizedMessage(LocalizedMessage value)
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4 [json_name = "localizedMessage"];

    • setLocalizedMessage

      public BadRequest.FieldViolation.Builder setLocalizedMessage(LocalizedMessage.Builder builderForValue)
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4 [json_name = "localizedMessage"];

    • mergeLocalizedMessage

      public BadRequest.FieldViolation.Builder mergeLocalizedMessage(LocalizedMessage value)
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4 [json_name = "localizedMessage"];

    • clearLocalizedMessage

      public BadRequest.FieldViolation.Builder clearLocalizedMessage()
       Provides a localized error message for field-level errors that is safe to
 return to the API consumer.
      .google.rpc.LocalizedMessage localized_message = 4 [json_name = "localizedMessage"];