Class protos.google.rpc.Status

Represents a Status.

Package

@google-cloud/spanner!

Constructors

(constructor)(properties)

constructor(properties?:google.rpc.IStatus);

Constructs a new Status.

Parameter
TypeNameDescription
IStatusproperties

Properties to set

Properties

code

publiccode:number;

Status code.

Property Value
TypeDescription
number

details

publicdetails:google.protobuf.IAny[];

Status details.

Property Value
TypeDescription
google.protobuf.IAny[]

message

publicmessage:string;

Status message.

Property Value
TypeDescription
string

Methods

create(properties)

publicstaticcreate(properties?:google.rpc.IStatus):google.rpc.Status;

Creates a new Status instance using the specified properties.

Parameter
TypeNameDescription
IStatusproperties

Properties to set

Returns
TypeDescription
google.rpc.Status

Status instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.rpc.Status;

Decodes a Status 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.Status

Status

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.rpc.Status;

Decodes a Status 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.Status

Status

encode(message, writer)

publicstaticencode(message:google.rpc.IStatus,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified Status message. Does not implicitly messages.

Parameters
TypeNameDescription
IStatusmessage

Status message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.rpc.IStatus,writer?:$protobuf.Writer):$protobuf.Writer;

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

Parameters
TypeNameDescription
IStatusmessage

Status message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.rpc.Status;

Creates a Status 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.Status

Status

toJSON()

publictoJSON():{[k:string]:any};

Converts this Status to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.rpc.Status,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
TypeNameDescription
google.rpc.Statusmessage

Status

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies a Status 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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.