Class: DescribeActivityExecutionRequest

Represents a DescribeActivityExecutionRequest.

Properties

activityId

activityId: string

DescribeActivityExecutionRequest activityId.

---

includeHeartbeatDetails

includeHeartbeatDetails: boolean

Include the heartbeat_details field inside info in the response if available.

---

includeInput

includeInput: boolean

Include the input field in the response.

---

includeLastFailure

includeLastFailure: boolean

Include the last_failure field inside info in the response if available.

---

includeOutcome

includeOutcome: boolean

Include the outcome (result/failure) in the response if the activity has completed.

---

longPollToken

longPollToken: Uint8Array

Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that activity state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.

---

namespace

namespace: string

DescribeActivityExecutionRequest namespace.

---

runId

runId: string

Activity run ID. If empty the request targets the latest run.

Methods

toJSON()

toJSON(): object

Converts this DescribeActivityExecutionRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): DescribeActivityExecutionRequest & $Properties

Creates a new DescribeActivityExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

DescribeActivityExecutionRequest & $Properties

DescribeActivityExecutionRequest instance

Call Signature

static create(properties?): DescribeActivityExecutionRequest

Creates a new DescribeActivityExecutionRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

DescribeActivityExecutionRequest

DescribeActivityExecutionRequest instance

---

decode()

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

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

DescribeActivityExecutionRequest & $Properties

DescribeActivityExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): DescribeActivityExecutionRequest & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

DescribeActivityExecutionRequest & $Properties

DescribeActivityExecutionRequest

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

Parameters

message

$Properties

DescribeActivityExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

DescribeActivityExecutionRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): DescribeActivityExecutionRequest

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

Parameters

object

Plain object

Returns

DescribeActivityExecutionRequest

DescribeActivityExecutionRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

DescribeActivityExecutionRequest

DescribeActivityExecutionRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object