Class protos.google.rpc.PreconditionFailure.Violation

Represents a Violation.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

constructor(properties?: google.rpc.PreconditionFailure.IViolation);

Constructs a new Violation.

Parameter
TypeNameDescription
IViolationproperties

Properties to set

Properties

description

public description: string;

Violation description.

Property Value
TypeDescription
string

subject

public subject: string;

Violation subject.

Property Value
TypeDescription
string

type

public type: string;

Violation type.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.rpc.PreconditionFailure.IViolation): google.rpc.PreconditionFailure.Violation;

Creates a new Violation instance using the specified properties.

Parameter
TypeNameDescription
IViolationproperties

Properties to set

Returns
TypeDescription
google.rpc.PreconditionFailure.Violation

Violation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.rpc.PreconditionFailure.Violation;

Decodes a Violation message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.rpc.PreconditionFailure.Violation

Violation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.rpc.PreconditionFailure.Violation;

Decodes a Violation message from the specified reader or buffer, length delimited.

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.rpc.PreconditionFailure.Violation

Violation

encode(message, writer)

public static encode(message: google.rpc.PreconditionFailure.IViolation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Violation message. Does not implicitly messages.

Parameters
TypeNameDescription
IViolationmessage

Violation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.rpc.PreconditionFailure.IViolation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Violation message, length delimited. Does not implicitly messages.

Parameters
TypeNameDescription
IViolationmessage

Violation message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.rpc.PreconditionFailure.Violation;

Creates a Violation message from a plain object. Also converts values to their respective internal types.

Parameter
TypeNameDescription
{ [k: string]: any }object

Plain object

Returns
TypeDescription
google.rpc.PreconditionFailure.Violation

Violation

toJSON()

public toJSON(): { [k: string]: any };

Converts this Violation to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.rpc.PreconditionFailure.Violation, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Violation message. Also converts values to other types if specified.

Parameters
TypeNameDescription
google.rpc.PreconditionFailure.Violationmessage

Violation

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Violation message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not