Interface BadRequest.FieldViolationOrBuilder (2.34.0)

public static interface BadRequest.FieldViolationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDescription()

public abstract String getDescription()

A description of why the request element is bad.

string description = 2;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

A description of why the request element is bad.

string description = 2;

Returns
Type	Description
`ByteString`	The bytes for description.

getField()

public abstract 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;

Returns
Type	Description
`String`	The field.

getFieldBytes()

public abstract 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;

Returns
Type	Description
`ByteString`	The bytes for field.