Interface BadRequest.FieldViolationOrBuilder (2.37.1)

Version 2.37.1

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

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.