Skip to main content

Interface: ActivityClientInterceptor

Implement any of these methods to intercept ActivityClient outbound calls

Properties​

cancel?​

optional cancel?: (input, next) => Promise<void>

Intercept a service call to requestCancelActivityExecution

Parameters​

input​

ActivityCancelInput

next​

OmitLastParam<(input: ActivityCancelInput, next: OmitLastParam<...>) => Promise<void>>

Returns​

Promise<void>

count?​

optional count?: (input, next) => Promise<CountActivityExecutions>

Intercept a service call to countActivityExecutions

Parameters​

input​

ActivityCountInput

next​

OmitLastParam<(input: ActivityCountInput, next: OmitLastParam<...>) => Promise<CountActivityExecutions>>

Returns​

Promise<CountActivityExecutions>

describe?​

optional describe?: (input, next) => Promise<ActivityExecutionDescription>

Intercept a service call to describeActivityExecution

Parameters​

input​

ActivityDescribeInput

next​

OmitLastParam<(input: ActivityDescribeInput, next: OmitLastParam<...>) => Promise<ActivityExecutionDescription>>

Returns​

Promise<ActivityExecutionDescription>

getResult?​

optional getResult?: (input, next) => Promise<any>

Intercept a service call to pollActivityExecution

Parameters​

input​

ActivityGetResultInput

next​

OmitLastParam<(input: ActivityGetResultInput, next: OmitLastParam<...>) => Promise<any>>

Returns​

Promise<any>

list?​

optional list?: (input, next) => AsyncIterable<ActivityExecutionInfo>

Intercept a service call to listActivityExecutions

Parameters​

input​

ActivityListInput

next​

OmitLastParam<(input: ActivityListInput, next: OmitLastParam<...>) => AsyncIterable<ActivityExecutionInfo>>

Returns​

AsyncIterable<ActivityExecutionInfo>

pause?​

optional pause?: (input, next) => Promise<void>

Experimental

Intercept a service call to pauseActivityExecution

Activity Operator Commands are experimental. APIs may be subject to change.

Parameters​

input​

ActivityPauseInput

next​

OmitLastParam<(input: ActivityPauseInput, next: OmitLastParam<...>) => Promise<void>>

Returns​

Promise<void>

restoreOriginalOptions?​

optional restoreOriginalOptions?: (input, next) => Promise<ActivityOptionsUpdate>

Experimental

Intercept a service call to updateActivityExecutionOptions(restoreOriginal=true)

Activity Operator Commands are experimental. APIs may be subject to change.

Parameters​

input​

ActivityRestoreOriginalOptionsInput

next​

OmitLastParam<(input: ActivityRestoreOriginalOptionsInput, next: OmitLastParam<...>) => Promise<ActivityOptionsUpdate>>

Returns​

Promise<ActivityOptionsUpdate>

start?​

optional start?: (input, next) => Promise<ActivityHandle<any>>

Intercept a service call to startActivityExecution

Parameters​

input​

ActivityStartInput

next​

OmitLastParam<(input: ActivityStartInput, next: OmitLastParam<...>) => Promise<ActivityHandle<any>>>

Returns​

Promise<ActivityHandle<any>>

terminate?​

optional terminate?: (input, next) => Promise<void>

Intercept a service call to terminateActivityExecution

Parameters​

input​

ActivityTerminateInput

next​

OmitLastParam<(input: ActivityTerminateInput, next: OmitLastParam<...>) => Promise<void>>

Returns​

Promise<void>

unpause?​

optional unpause?: (input, next) => Promise<void>

Experimental

Intercept a service call to unpauseActivityExecution

Activity Operator Commands are experimental. APIs may be subject to change.

Parameters​

input​

ActivityUnpauseInput

next​

OmitLastParam<(input: ActivityUnpauseInput, next: OmitLastParam<...>) => Promise<void>>

Returns​

Promise<void>

updateOptions?​

optional updateOptions?: (input, next) => Promise<ActivityOptionsUpdateResult>

Experimental

Intercept a service call to updateActivityExecutionOptions(restoreOriginal=false)

Activity Operator Commands are experimental. APIs may be subject to change.

Parameters​

input​

ActivityUpdateOptionsInput

next​

OmitLastParam<(input: ActivityUpdateOptionsInput, next: OmitLastParam<...>) => Promise<ActivityOptionsUpdateResult>>

Returns​

Promise<ActivityOptionsUpdateResult>