Class: FetchWorkerConfigRequest

Represents a FetchWorkerConfigRequest.

Properties

identity

identity: string

The identity of the client who initiated this request.

---

namespace

namespace: string

Namespace this worker belongs to.

---

reason

reason: string

Reason for sending worker command, can be used for audit purpose.

---

resourceId

resourceId: string

Resource ID for routing. Contains the worker grouping key.

---

selector?

optional selector?: $Properties | null

Defines which workers should receive this command. only single worker is supported at this time.

Methods

toJSON()

toJSON(): object

Converts this FetchWorkerConfigRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): FetchWorkerConfigRequest & $Shape

Creates a new FetchWorkerConfigRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

FetchWorkerConfigRequest & $Shape

FetchWorkerConfigRequest instance

Call Signature

static create(properties?): FetchWorkerConfigRequest

Creates a new FetchWorkerConfigRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

FetchWorkerConfigRequest

FetchWorkerConfigRequest instance

---

decode()

static decode(reader, length?): FetchWorkerConfigRequest & $Shape

Decodes a FetchWorkerConfigRequest 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

FetchWorkerConfigRequest & $Shape

FetchWorkerConfigRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): FetchWorkerConfigRequest & $Shape

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

FetchWorkerConfigRequest & $Shape

FetchWorkerConfigRequest

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 FetchWorkerConfigRequest message. Does not implicitly temporal.api.workflowservice.v1.FetchWorkerConfigRequest.verify|verify messages.

Parameters

message

$Properties

FetchWorkerConfigRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

FetchWorkerConfigRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): FetchWorkerConfigRequest

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

Parameters

object

Plain object

Returns

FetchWorkerConfigRequest

FetchWorkerConfigRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

FetchWorkerConfigRequest

FetchWorkerConfigRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object