Skip to main content

Class: ResourceExhaustedFailure

errordetails.v1.ResourceExhaustedFailure

Represents a ResourceExhaustedFailure.

Implements

Constructors

constructor

new ResourceExhaustedFailure(properties?): ResourceExhaustedFailure

Constructs a new ResourceExhaustedFailure.

Parameters

NameTypeDescription
properties?IResourceExhaustedFailureProperties to set

Returns

ResourceExhaustedFailure

Properties

cause

cause: ResourceExhaustedCause

ResourceExhaustedFailure cause.

Implementation of

IResourceExhaustedFailure.cause


scope

scope: ResourceExhaustedScope

ResourceExhaustedFailure scope.

Implementation of

IResourceExhaustedFailure.scope

Methods

toJSON

toJSON(): Object

Converts this ResourceExhaustedFailure to JSON.

Returns

Object

JSON object


create

create(properties?): ResourceExhaustedFailure

Creates a new ResourceExhaustedFailure instance using the specified properties.

Parameters

NameTypeDescription
properties?IResourceExhaustedFailureProperties to set

Returns

ResourceExhaustedFailure

ResourceExhaustedFailure instance


decode

decode(reader, length?): ResourceExhaustedFailure

Decodes a ResourceExhaustedFailure message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

ResourceExhaustedFailure

ResourceExhaustedFailure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): ResourceExhaustedFailure

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

ResourceExhaustedFailure

ResourceExhaustedFailure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified ResourceExhaustedFailure message. Does not implicitly temporal.api.errordetails.v1.ResourceExhaustedFailure.verify|verify messages.

Parameters

NameTypeDescription
messageIResourceExhaustedFailureResourceExhaustedFailure message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified ResourceExhaustedFailure message, length delimited. Does not implicitly temporal.api.errordetails.v1.ResourceExhaustedFailure.verify|verify messages.

Parameters

NameTypeDescription
messageIResourceExhaustedFailureResourceExhaustedFailure message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): ResourceExhaustedFailure

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

ResourceExhaustedFailure

ResourceExhaustedFailure


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ResourceExhaustedFailure

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageResourceExhaustedFailureResourceExhaustedFailure
options?IConversionOptionsConversion options

Returns

Object

Plain object