Class PreconditionFailure.Types.Violation (2.2.0)

public sealed class Violation : Protobuf.IMessage<PreconditionFailure.Types.Violation>, Protobuf.IBufferMessage

A message type used to describe a single precondition failure.

Inheritance

Object > PreconditionFailure.Types.Violation

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

Violation()

public Violation()

Violation(PreconditionFailure.Types.Violation)

public Violation(PreconditionFailure.Types.Violation other)
Parameter
NameDescription
otherPreconditionFailure.Types.Violation

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
TypeDescription
Int32

SubjectFieldNumber

public const int SubjectFieldNumber = 2

Field number for the "subject" field.

Field Value
TypeDescription
Int32

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
TypeDescription
Int32

Properties

Description

public string Description { get; set; }

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: "Terms of service not accepted".

Property Value
TypeDescription
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

Parser

public static Protobuf.MessageParser<PreconditionFailure.Types.Violation> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<PreconditionFailure.Types.Violation>

Subject

public string Subject { get; set; }

The subject, relative to the type, that failed. For example, "google.com/cloud" relative to the "TOS" type would indicate which terms of service is being referenced.

Property Value
TypeDescription
String

Type

public string Type { get; set; }

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, "TOS" for "Terms of Service violation".

Property Value
TypeDescription
String

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public PreconditionFailure.Types.Violation Clone()
Returns
TypeDescription
PreconditionFailure.Types.Violation

Equals(PreconditionFailure.Types.Violation)

public bool Equals(PreconditionFailure.Types.Violation other)
Parameter
NameDescription
otherPreconditionFailure.Types.Violation
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
NameDescription
otherObject
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
NameDescription
inputProtobuf.CodedInputStream

MergeFrom(PreconditionFailure.Types.Violation)

public void MergeFrom(PreconditionFailure.Types.Violation other)
Parameter
NameDescription
otherPreconditionFailure.Types.Violation

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
NameDescription
outputProtobuf.CodedOutputStream