Skip to main content

Class: ComputeProvider

ComputeProvider stores information used by a worker control plane controller to respond to worker lifecycle events. For example, when a Task is received on a TaskQueue that has no active pollers, a serverless worker lifecycle controller might need to invoke an AWS Lambda Function that itself ends up calling the SDK's worker.New() function.

Properties​

details?​

optional details?: $Properties | null

Contains provider-specific instructions and configuration. For server-implemented providers, use the SDK's default content converter to ensure the server can understand it. For remote-implemented providers, you might use your own content converters according to what the remote endpoints understand.

nexusEndpoint​

nexusEndpoint: string

Optional. If the compute provider is a Nexus service, this should point there.

type​

type: string

Type of the compute provider. This string is implementation-specific and can be used by implementations to understand how to interpret the contents of the provider_details field.

Methods​

toJSON()​

toJSON(): object

Converts this ComputeProvider to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ComputeProvider & $Properties

Creates a new ComputeProvider instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ComputeProvider & $Properties

ComputeProvider instance

Call Signature​

static create(properties?): ComputeProvider

Creates a new ComputeProvider instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ComputeProvider

ComputeProvider instance

decode()​

static decode(reader, length?): ComputeProvider & $Properties

Decodes a ComputeProvider message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ComputeProvider & $Properties

ComputeProvider

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ComputeProvider & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ComputeProvider & $Properties

ComputeProvider

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ComputeProvider message. Does not implicitly temporal.api.compute.v1.ComputeProvider.verify|verify messages.

Parameters​

message​

$Properties

ComputeProvider message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ComputeProvider message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ComputeProvider

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

Parameters​

object​

Plain object

Returns​

ComputeProvider

ComputeProvider

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ComputeProvider

ComputeProvider

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object