Class BadRequest.Types.FieldViolation (2.10.0)

Version latest

• 2.10.0 (latest)
• 2.2.0

public sealed class BadRequest.Types.FieldViolation : IMessage<BadRequest.Types.FieldViolation>, IEquatable<BadRequest.Types.FieldViolation>, IDeepCloneable<BadRequest.Types.FieldViolation>, IBufferMessage, IMessage

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

Inheritance

object > BadRequest.Types.FieldViolation

Implements

IMessageBadRequestTypesFieldViolation, IEquatableBadRequestTypesFieldViolation, IDeepCloneableBadRequestTypesFieldViolation, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

FieldViolation()

public FieldViolation()

FieldViolation(FieldViolation)

public FieldViolation(BadRequest.Types.FieldViolation other)

Parameter
Name	Description
other	BadRequestTypesFieldViolation

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 2

Field number for the "description" field.

Field Value
Type	Description
int

FieldFieldNumber

public const int FieldFieldNumber = 1

Field number for the "field" field.

Field Value
Type	Description
int

Properties

Description

public string Description { get; set; }

A description of why the request element is bad.

Property Value
Type	Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

Field

public string Field { get; set; }

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.

Property Value
Type	Description
string

Parser

public static MessageParser<BadRequest.Types.FieldViolation> Parser { get; }

Property Value
Type	Description
MessageParserBadRequestTypesFieldViolation

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
int

Clone()

public BadRequest.Types.FieldViolation Clone()

Returns
Type	Description
BadRequestTypesFieldViolation

Equals(FieldViolation)

public bool Equals(BadRequest.Types.FieldViolation other)

Parameter
Name	Description
other	BadRequestTypesFieldViolation

Returns
Type	Description
bool

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
other	object

Returns
Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

MergeFrom(FieldViolation)

public void MergeFrom(BadRequest.Types.FieldViolation other)

Parameter
Name	Description
other	BadRequestTypesFieldViolation

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream