public static interface BadRequest.FieldViolationOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDescription()
public abstract String getDescription()
A description of why the request element is bad.
string description = 2;
Type | Description |
String | The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()
A description of why the request element is bad.
string description = 2;
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 thefull_name
valueemail_addresses[1].email
for a violation in theemail
field of the firstemail_addresses
messageemail_addresses[3].type[2]
for a violation in the secondtype
value in the thirdemail_addresses
message. In JSON, the same values are represented as:fullName
for a violation in thefullName
valueemailAddresses[1].email
for a violation in theemail
field of the firstemailAddresses
messageemailAddresses[3].type[2]
for a violation in the secondtype
value in the thirdemailAddresses
message.
string field = 1;
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 thefull_name
valueemail_addresses[1].email
for a violation in theemail
field of the firstemail_addresses
messageemail_addresses[3].type[2]
for a violation in the secondtype
value in the thirdemail_addresses
message. In JSON, the same values are represented as:fullName
for a violation in thefullName
valueemailAddresses[1].email
for a violation in theemail
field of the firstemailAddresses
messageemailAddresses[3].type[2]
for a violation in the secondtype
value in the thirdemailAddresses
message.
string field = 1;
Type | Description |
ByteString | The bytes for field. |