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

Implements

Protobuf.IBufferMessage

Namespace

Google.Rpc

Assembly

Google.Api.CommonProtos.dll

Constructors

Violation()

public Violation()

Violation(PreconditionFailure.Types.Violation)

public Violation(PreconditionFailure.Types.Violation other)

Parameter
Name	Description
`other`	`PreconditionFailure.Types.Violation`

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
Type	Description
`Int32`

SubjectFieldNumber

public const int SubjectFieldNumber = 2

Field number for the "subject" field.

Field Value
Type	Description
`Int32`

TypeFieldNumber

public const int TypeFieldNumber = 1

Field number for the "type" field.

Field Value
Type	Description
`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
Type	Description
`String`

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`Protobuf.Reflection.MessageDescriptor`

Parser

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

Property Value
Type	Description
`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
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()

Returns
Type	Description
`Int32`

Clone()

public PreconditionFailure.Types.Violation Clone()

Returns
Type	Description
`PreconditionFailure.Types.Violation`

Equals(PreconditionFailure.Types.Violation)

public bool Equals(PreconditionFailure.Types.Violation other)

Parameter
Name	Description
`other`	`PreconditionFailure.Types.Violation`

Returns
Type	Description
`Boolean`

Equals(Object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`Object`

Returns
Type	Description
`Boolean`

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`Int32`

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)

Parameter
Name	Description
`input`	`Protobuf.CodedInputStream`

MergeFrom(PreconditionFailure.Types.Violation)

public void MergeFrom(PreconditionFailure.Types.Violation other)

Parameter
Name	Description
`other`	`PreconditionFailure.Types.Violation`

ToString()

public override string ToString()

Returns
Type	Description
`String`

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)

Parameter
Name	Description
`output`	`Protobuf.CodedOutputStream`