Class BadRequest.FieldViolation (2.65.0)

A message type used to describe a single bad request field.

Protobuf type google.rpc.BadRequest.FieldViolation

A description of why the request element is bad.

string description = 2;

A description of why the request element is bad.

string description = 2;

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;

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;

Provides a localized error message for field-level errors that is safe to return to the API consumer.

.google.rpc.LocalizedMessage localized_message = 4;

Provides a localized error message for field-level errors that is safe to return to the API consumer.

.google.rpc.LocalizedMessage localized_message = 4;

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], which represents UPPER_SNAKE_CASE.

string reason = 3;

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], which represents UPPER_SNAKE_CASE.

string reason = 3;

Provides a localized error message for field-level errors that is safe to return to the API consumer.

.google.rpc.LocalizedMessage localized_message = 4;