Skip to main content

Class: OnDemand

v1.CapacitySpec.OnDemand

Represents an OnDemand.

Methods​

toJSON​

▸ toJSON(): Object

Converts this OnDemand to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): OnDemand & $Properties

Creates a new OnDemand instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

OnDemand & $Properties

OnDemand instance

▸ create(properties?): OnDemand

Parameters​

NameType
properties?$Properties

Returns​

OnDemand


decode​

▸ decode(reader, length?): OnDemand & $Properties

Decodes an OnDemand message from the specified reader or buffer.

Parameters​

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

Returns​

OnDemand & $Properties

OnDemand

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): OnDemand & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

OnDemand & $Properties

OnDemand

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 OnDemand message. Does not implicitly temporal.api.cloud.namespace.v1.CapacitySpec.OnDemand.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesOnDemand message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified OnDemand message, length delimited. Does not implicitly temporal.api.cloud.namespace.v1.CapacitySpec.OnDemand.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesOnDemand message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): OnDemand

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

OnDemand

OnDemand


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageOnDemandOnDemand
options?IConversionOptionsConversion options

Returns​

Object

Plain object