Class protos.google.cloud.compute.v1.ErrorDetails (4.6.0)

Represents an ErrorDetails.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1.IErrorDetails);

Constructs a new ErrorDetails.

Parameter
Name Description
properties IErrorDetails

Properties to set

Properties

_errorInfo

public _errorInfo?: "errorInfo";

ErrorDetails _errorInfo.

_help

public _help?: "help";

ErrorDetails _help.

_localizedMessage

public _localizedMessage?: "localizedMessage";

ErrorDetails _localizedMessage.

_quotaInfo

public _quotaInfo?: "quotaInfo";

ErrorDetails _quotaInfo.

errorInfo

public errorInfo?: (google.cloud.compute.v1.IErrorInfo|null);

ErrorDetails errorInfo.

help

public help?: (google.cloud.compute.v1.IHelp|null);

ErrorDetails help.

localizedMessage

public localizedMessage?: (google.cloud.compute.v1.ILocalizedMessage|null);

ErrorDetails localizedMessage.

quotaInfo

public quotaInfo?: (google.cloud.compute.v1.IQuotaExceededInfo|null);

ErrorDetails quotaInfo.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1.IErrorDetails): google.cloud.compute.v1.ErrorDetails;

Creates a new ErrorDetails instance using the specified properties.

Parameter
Name Description
properties IErrorDetails

Properties to set

Returns
Type Description
ErrorDetails

ErrorDetails instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.ErrorDetails;

Decodes an ErrorDetails message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
ErrorDetails

ErrorDetails

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.ErrorDetails;

Decodes an ErrorDetails message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
ErrorDetails

ErrorDetails

encode(message, writer)

public static encode(message: google.cloud.compute.v1.IErrorDetails, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ErrorDetails message. Does not implicitly messages.

Parameters
Name Description
message IErrorDetails

ErrorDetails message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.compute.v1.IErrorDetails, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IErrorDetails

ErrorDetails message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.ErrorDetails;

Creates an ErrorDetails 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
ErrorDetails

ErrorDetails

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ErrorDetails

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

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

Converts this ErrorDetails to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.compute.v1.ErrorDetails, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message ErrorDetails

ErrorDetails

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an ErrorDetails message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not