Skip to main content

Interface: IDescribeNexusOperationExecutionRequest

workflowservice.v1.IDescribeNexusOperationExecutionRequest

Properties of a DescribeNexusOperationExecutionRequest.

Hierarchy​

  • $Properties

    ↳ IDescribeNexusOperationExecutionRequest

Properties​

includeInput​

• Optional includeInput: null | boolean

Include the input field in the response.

Inherited from​

$Properties.includeInput

includeOutcome​

• Optional includeOutcome: null | boolean

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

Inherited from​

$Properties.includeOutcome

longPollToken​

• Optional longPollToken: null | Uint8Array

Token from a previous DescribeNexusOperationExecutionResponse. If present, this RPC will long-poll until operation 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 operation 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.

Inherited from​

$Properties.longPollToken

namespace​

• Optional namespace: null | string

DescribeNexusOperationExecutionRequest namespace

Inherited from​

$Properties.namespace

operationId​

• Optional operationId: null | string

DescribeNexusOperationExecutionRequest operationId

Inherited from​

$Properties.operationId

runId​

• Optional runId: null | string

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

Inherited from​

$Properties.runId