Class PreconditionFailure.Types.Violation (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

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

A message type used to describe a single precondition failure.

Inheritance

object > PreconditionFailure.Types.Violation

Implements

IMessagePreconditionFailureTypesViolation, IEquatablePreconditionFailureTypesViolation, IDeepCloneablePreconditionFailureTypesViolation, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

Violation()

public Violation()

Violation(Violation)

public Violation(PreconditionFailure.Types.Violation other)

Parameter
Name	Description
other	PreconditionFailureTypesViolation

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
Type	Description
int

SubjectFieldNumber

public const int SubjectFieldNumber = 2

Field number for the "subject" field.

Field Value
Type	Description
int

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
Type	Description
int

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
Type	Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

Parser

public static MessageParser<PreconditionFailure.Types.Violation> Parser { get; }

Property Value
Type	Description
MessageParserPreconditionFailureTypesViolation

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
Type	Description
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
Type	Description
string

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

Clone()

public PreconditionFailure.Types.Violation Clone()

Creates a deep clone of this object.

Returns
Type	Description
PreconditionFailureTypesViolation	A deep clone of this object.

Equals(Violation)

public bool Equals(PreconditionFailure.Types.Violation other)

Parameter
Name	Description
other	PreconditionFailureTypesViolation

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)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(Violation)

public void MergeFrom(PreconditionFailure.Types.Violation other)

Merges the given message into this one.

Parameter
Name	Description
other	PreconditionFailureTypesViolation

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.