Class BadRequest.FieldViolation (2.29.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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

FIELD_FIELD_NUMBER

public static final int FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BadRequest.FieldViolation getDefaultInstance()
Returns
TypeDescription
BadRequest.FieldViolation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static BadRequest.FieldViolation.Builder newBuilder()
Returns
TypeDescription
BadRequest.FieldViolation.Builder

newBuilder(BadRequest.FieldViolation prototype)

public static BadRequest.FieldViolation.Builder newBuilder(BadRequest.FieldViolation prototype)
Parameter
NameDescription
prototypeBadRequest.FieldViolation
Returns
TypeDescription
BadRequest.FieldViolation.Builder

parseDelimitedFrom(InputStream input)

public static BadRequest.FieldViolation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static BadRequest.FieldViolation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BadRequest.FieldViolation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BadRequest.FieldViolation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static BadRequest.FieldViolation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static BadRequest.FieldViolation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BadRequest.FieldViolation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BadRequest.FieldViolation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public BadRequest.FieldViolation getDefaultInstanceForType()
Returns
TypeDescription
BadRequest.FieldViolation

getDescription()

public String getDescription()

A description of why the request element is bad.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

A description of why the request element is bad.

string description = 2;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for field.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public BadRequest.FieldViolation.Builder newBuilderForType()
Returns
TypeDescription
BadRequest.FieldViolation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BadRequest.FieldViolation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
BadRequest.FieldViolation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public BadRequest.FieldViolation.Builder toBuilder()
Returns
TypeDescription
BadRequest.FieldViolation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException