Reference documentation and code samples for the Google API Common Protos Client class FieldViolation.
A message type used to describe a single bad request field.
Generated from protobuf message google.rpc.BadRequest.FieldViolation
Namespace
Google \ Rpc \ BadRequestMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ field
string
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.
↳ description
string
A description of why the request element is bad.
↳ reason
string
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.
↳ localized_message
Google\Rpc\LocalizedMessage
Provides a localized error message for field-level errors that is safe to return to the API consumer.
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_namefor a violation in thefull_namevalue -
email_addresses[1].emailfor a violation in theemailfield of the firstemail_addressesmessage -
email_addresses[3].type[2]for a violation in the secondtypevalue in the thirdemail_addressesmessage. In JSON, the same values are represented as: -
fullNamefor a violation in thefullNamevalue -
emailAddresses[1].emailfor a violation in theemailfield of the firstemailAddressesmessage -
emailAddresses[3].type[2]for a violation in the secondtypevalue in the thirdemailAddressesmessage.
string
setField
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_namefor a violation in thefull_namevalue -
email_addresses[1].emailfor a violation in theemailfield of the firstemail_addressesmessage -
email_addresses[3].type[2]for a violation in the secondtypevalue in the thirdemail_addressesmessage. In JSON, the same values are represented as: -
fullNamefor a violation in thefullNamevalue -
emailAddresses[1].emailfor a violation in theemailfield of the firstemailAddressesmessage -
emailAddresses[3].type[2]for a violation in the secondtypevalue in the thirdemailAddressesmessage.
var
string
$this
getDescription
A description of why the request element is bad.
string
setDescription
A description of why the request element is bad.
var
string
$this
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
setReason
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.
var
string
$this
getLocalizedMessage
Provides a localized error message for field-level errors that is safe to return to the API consumer.
hasLocalizedMessage
clearLocalizedMessage
setLocalizedMessage
Provides a localized error message for field-level errors that is safe to return to the API consumer.
$this
