Represents a Status.
Package
@google-cloud/dataflow!Constructors
(constructor)(properties)
constructor(properties?: google.rpc.IStatus);
Constructs a new Status.
Type | Name | Description |
---|---|---|
IStatus | properties |
Properties to set |
Properties
code
public code: number;
Status code.
Type | Description |
---|---|
number |
details
public details: google.protobuf.IAny[];
Status details.
Type | Description |
---|---|
google.protobuf.IAny[] |
message
public message: string;
Status message.
Type | Description |
---|---|
string |
Methods
create(properties)
public static create(properties?: google.rpc.IStatus): google.rpc.Status;
Creates a new Status instance using the specified properties.
Type | Name | Description |
---|---|---|
IStatus | properties |
Properties to set |
Type | Description |
---|---|
google.rpc.Status | Status instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.rpc.Status;
Decodes a Status message from the specified reader or buffer.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
number | length |
Message length if known beforehand |
Type | Description |
---|---|
google.rpc.Status | Status |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.rpc.Status;
Decodes a Status message from the specified reader or buffer, length delimited.
Type | Name | Description |
---|---|---|
($protobuf.Reader|Uint8Array) | reader |
Reader or buffer to decode from |
Type | Description |
---|---|
google.rpc.Status | Status |
encode(message, writer)
public static encode(message: google.rpc.IStatus, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Status message. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IStatus | message |
Status message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.rpc.IStatus, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified Status message, length delimited. Does not implicitly messages.
Type | Name | Description |
---|---|---|
IStatus | message |
Status message or plain object to encode |
$protobuf.Writer | writer |
Writer to encode to |
Type | Description |
---|---|
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.rpc.Status;
Creates a Status message from a plain object. Also converts values to their respective internal types.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | object |
Plain object |
Type | Description |
---|---|
google.rpc.Status | Status |
toJSON()
public toJSON(): { [k: string]: any };
Converts this Status to JSON.
Type | Description |
---|---|
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(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.
Type | Name | Description |
---|---|---|
google.rpc.Status | message |
Status |
$protobuf.IConversionOptions | options |
Conversion options |
Type | Description |
---|---|
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);
Verifies a Status message.
Type | Name | Description |
---|---|---|
{ [k: string]: any } | message |
Plain object to verify |
Type | Description |
---|---|
(string|null) |
|