Skip to main content

Class: Limits

coresdk.NamespaceInfo.Limits

Represents a Limits.

Implements

Constructors

constructor

new Limits(properties?): Limits

Constructs a new Limits.

Parameters

NameTypeDescription
properties?ILimitsProperties to set

Returns

Limits

Properties

blobSizeLimitError

blobSizeLimitError: Long

Maximum size in bytes for payload fields in workflow history events (e.g., workflow/activity inputs and results, failure details, signal payloads). When exceeded, the server will reject the operation with an error.

Implementation of

ILimits.blobSizeLimitError


memoSizeLimitError

memoSizeLimitError: Long

Maximum total memo size in bytes per workflow execution.

Implementation of

ILimits.memoSizeLimitError

Methods

toJSON

toJSON(): Object

Converts this Limits to JSON.

Returns

Object

JSON object


create

create(properties?): Limits

Creates a new Limits instance using the specified properties.

Parameters

NameTypeDescription
properties?ILimitsProperties to set

Returns

Limits

Limits instance


decode

decode(reader, length?): Limits

Decodes a Limits message from the specified reader or buffer.

Parameters

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

Returns

Limits

Limits

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Limits

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Limits

Limits

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 Limits message. Does not implicitly coresdk.NamespaceInfo.Limits.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified Limits message, length delimited. Does not implicitly coresdk.NamespaceInfo.Limits.verify|verify messages.

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Limits

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Limits

Limits


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Limits

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 Limits message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageLimitsLimits
options?IConversionOptionsConversion options

Returns

Object

Plain object