Skip to main content

Interface: ActivityClientInterceptor

client.ActivityClientInterceptor

Implement any of these methods to intercept ActivityClient outbound calls

Properties​

cancel​

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

Intercept a service call to requestCancelActivityExecution

Type declaration​

▸ (input, next): Promise<void>

Parameters​
NameType
inputActivityCancelInput
nextOmitLastParam<(input: ActivityCancelInput, next: OmitLastParam<...>) => Promise<void>>
Returns​

Promise<void>

count​

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

Intercept a service call to countActivityExecutions

Type declaration​

▸ (input, next): Promise<CountActivityExecutions>

Parameters​
NameType
inputActivityCountInput
nextOmitLastParam<(input: ActivityCountInput, next: OmitLastParam<...>) => Promise<CountActivityExecutions>>
Returns​

Promise<CountActivityExecutions>

describe​

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

Intercept a service call to describeActivityExecution

Type declaration​

▸ (input, next): Promise<ActivityExecutionDescription>

Parameters​
NameType
inputActivityDescribeInput
nextOmitLastParam<(input: ActivityDescribeInput, next: OmitLastParam<...>) => Promise<ActivityExecutionDescription>>
Returns​

Promise<ActivityExecutionDescription>

getResult​

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

Intercept a service call to pollActivityExecution

Type declaration​

▸ (input, next): Promise<any>

Parameters​
NameType
inputActivityGetResultInput
nextOmitLastParam<(input: ActivityGetResultInput, next: OmitLastParam<...>) => Promise<any>>
Returns​

Promise<any>

list​

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

Intercept a service call to listActivityExecutions

Type declaration​

▸ (input, next): AsyncIterable<ActivityExecutionInfo>

Parameters​
NameType
inputActivityListInput
nextOmitLastParam<(input: ActivityListInput, next: OmitLastParam<...>) => AsyncIterable<ActivityExecutionInfo>>
Returns​

AsyncIterable<ActivityExecutionInfo>

pause​

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

Intercept a service call to pauseActivityExecution

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

Type declaration​

▸ (input, next): Promise<void>

Parameters​
NameType
inputActivityPauseInput
nextOmitLastParam<(input: ActivityPauseInput, next: OmitLastParam<...>) => Promise<void>>
Returns​

Promise<void>

restoreOriginalOptions​

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

Intercept a service call to updateActivityExecutionOptions(restoreOriginal=true)

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

Type declaration​

▸ (input, next): Promise<ActivityOptionsUpdate>

Parameters​
NameType
inputActivityRestoreOriginalOptionsInput
nextOmitLastParam<(input: ActivityRestoreOriginalOptionsInput, next: OmitLastParam<...>) => Promise<ActivityOptionsUpdate>>
Returns​

Promise<ActivityOptionsUpdate>

start​

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

Intercept a service call to startActivityExecution

Type declaration​

▸ (input, next): Promise<ActivityHandle<any>>

Parameters​
NameType
inputActivityStartInput
nextOmitLastParam<(input: ActivityStartInput, next: OmitLastParam<...>) => Promise<ActivityHandle<any>>>
Returns​

Promise<ActivityHandle<any>>

terminate​

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

Intercept a service call to terminateActivityExecution

Type declaration​

▸ (input, next): Promise<void>

Parameters​
NameType
inputActivityTerminateInput
nextOmitLastParam<(input: ActivityTerminateInput, next: OmitLastParam<...>) => Promise<void>>
Returns​

Promise<void>

unpause​

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

Intercept a service call to unpauseActivityExecution

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

Type declaration​

▸ (input, next): Promise<void>

Parameters​
NameType
inputActivityUnpauseInput
nextOmitLastParam<(input: ActivityUnpauseInput, next: OmitLastParam<...>) => Promise<void>>
Returns​

Promise<void>

updateOptions​

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

Intercept a service call to updateActivityExecutionOptions(restoreOriginal=false)

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

Type declaration​

▸ (input, next): Promise<ActivityOptionsUpdateResult>

Parameters​
NameType
inputActivityUpdateOptionsInput
nextOmitLastParam<(input: ActivityUpdateOptionsInput, next: OmitLastParam<...>) => Promise<ActivityOptionsUpdateResult>>
Returns​

Promise<ActivityOptionsUpdateResult>