Class BadRequest.FieldViolation (2.42.0) 

public static final class BadRequest.FieldViolation extends GeneratedMessageV3 implements BadRequest.FieldViolationOrBuilder

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

Protobuf type google.rpc.BadRequest.FieldViolation

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BadRequest.FieldViolation

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BadRequest.FieldViolation getDefaultInstance()
Returns
Type Description
BadRequest.FieldViolation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BadRequest.FieldViolation.Builder newBuilder()
Returns
Type Description
BadRequest.FieldViolation.Builder

newBuilder(BadRequest.FieldViolation prototype)

public static BadRequest.FieldViolation.Builder newBuilder(BadRequest.FieldViolation prototype)
Parameter
Name Description
prototype BadRequest.FieldViolation
Returns
Type Description
BadRequest.FieldViolation.Builder

parseDelimitedFrom(InputStream input)

public static BadRequest.FieldViolation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BadRequest.FieldViolation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BadRequest.FieldViolation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BadRequest.FieldViolation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BadRequest.FieldViolation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BadRequest.FieldViolation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BadRequest.FieldViolation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BadRequest.FieldViolation> parser()
Returns
Type Description
Parser<FieldViolation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BadRequest.FieldViolation getDefaultInstanceForType()
Returns
Type Description
BadRequest.FieldViolation

getDescription()

public String getDescription()

A description of why the request element is bad.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of why the request element is bad.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getField()

public 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 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.

getParserForType()

public Parser<BadRequest.FieldViolation> getParserForType()
Returns
Type Description
Parser<FieldViolation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BadRequest.FieldViolation.Builder newBuilderForType()
Returns
Type Description
BadRequest.FieldViolation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BadRequest.FieldViolation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BadRequest.FieldViolation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BadRequest.FieldViolation.Builder toBuilder()
Returns
Type Description
BadRequest.FieldViolation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException