Class protos.google.rpc.Status (4.5.0)
Represents a Status.
Package
@google-cloud/kmsConstructors
(constructor)(properties)
constructor(properties?:google.rpc.IStatus);Constructs a new Status.
| Parameter | |
|---|---|
| Name | Description |
properties | IStatusProperties to set |
Properties
code
publiccode:number;Status code.
details
publicdetails:google.protobuf.IAny[];Status details.
message
publicmessage:string;Status message.
Methods
create(properties)
publicstaticcreate(properties?:google.rpc.IStatus):google.rpc.Status;Creates a new Status instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties | IStatusProperties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
length | numberMessage length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader | (Reader|Uint8Array)Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message | IStatusStatus message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Name | Description |
message | IStatusStatus message or plain object to encode |
writer | $protobuf.WriterWriter to encode to |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Name | Description |
object | { [k: string]: any }Plain object |
| Returns | |
|---|---|
| Type | Description |
Status | Status |
getTypeUrl(typeUrlPrefix)
publicstaticgetTypeUrl(typeUrlPrefix?:string):string;Gets the default type url for Status
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix | stringyour custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
publictoJSON():{[k:string]:any};Converts this Status to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message | StatusStatus |
options | $protobuf.IConversionOptionsConversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
publicstaticverify(message:{[k:string]:any}):(string|null);Verifies a Status message.
| Parameter | |
|---|---|
| Name | Description |
message | { [k: string]: any }Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|
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.