Skip to main content

Class: Limits

coresdk.NamespaceInfo.Limits

Represents a 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.


memoSizeLimitError

memoSizeLimitError: Long

Maximum total memo size in bytes per workflow execution.

Methods

toJSON

toJSON(): Object

Converts this Limits to JSON.

Returns

Object

JSON object


create

create(properties?): Limits & $Properties

Creates a new Limits instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

Limits & $Properties

Limits instance

create(properties?): Limits

Parameters

NameType
properties?$Properties

Returns

Limits


decode

decode(reader, length?): Limits & $Properties

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 & $Properties

Limits

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Limits & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Limits & $Properties

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
message$PropertiesLimits 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
message$PropertiesLimits 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


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