src/longRunningCalls/longrunning.ts
Properties |
|
Methods |
constructor(grpcOp: LROOperation, longrunningDescriptor: LongRunningDescriptor, backoffSettings: BackoffSettings, callOptions?: CallOptions)
|
||||||||||||||||||||
Defined in src/longRunningCalls/longrunning.ts:59
|
||||||||||||||||||||
Wrapper for a google.longrunnung.Operation. operations service client and unpacking mechanisms for the operation. in polling the operation. requests.
Parameters :
|
Optional _callOptions |
Type : CallOptions
|
Defined in src/longRunningCalls/longrunning.ts:54
|
backoffSettings |
Type : BackoffSettings
|
Defined in src/longRunningCalls/longrunning.ts:53
|
completeListeners |
Type : number
|
Defined in src/longRunningCalls/longrunning.ts:47
|
Optional currentCallPromise_ |
Type : CancellablePromise<ResultTuple>
|
Defined in src/longRunningCalls/longrunning.ts:55
|
Optional done |
Type : boolean
|
Defined in src/longRunningCalls/longrunning.ts:57
|
Optional error |
Type : GoogleError
|
Defined in src/longRunningCalls/longrunning.ts:58
|
hasActiveListeners |
Type : boolean
|
Defined in src/longRunningCalls/longrunning.ts:48
|
latestResponse |
Type : LROOperation
|
Defined in src/longRunningCalls/longrunning.ts:49
|
longrunningDescriptor |
Type : LongRunningDescriptor
|
Defined in src/longRunningCalls/longrunning.ts:50
|
metadata |
Type : Metadata | null
|
Defined in src/longRunningCalls/longrunning.ts:52
|
Optional name |
Type : string
|
Defined in src/longRunningCalls/longrunning.ts:56
|
Optional response |
Type : literal type
|
Defined in src/longRunningCalls/longrunning.ts:59
|
result |
Type : literal type | null
|
Defined in src/longRunningCalls/longrunning.ts:51
|
_listenForEvents |
_listenForEvents()
|
Defined in src/longRunningCalls/longrunning.ts:106
|
Begin listening for events on the operation. This method keeps track of how many "complete" listeners are registered and removed, making sure polling is handled automatically. As long as there is one active "complete" listener, the connection is open. When there are no more listeners, the polling stops.
Returns :
void
|
_unpackResponse | |||||||||
_unpackResponse(op: LROOperation, callback?: GetOperationCallback)
|
|||||||||
Defined in src/longRunningCalls/longrunning.ts:212
|
|||||||||
Parameters :
Returns :
void
|
cancel |
cancel()
|
Defined in src/longRunningCalls/longrunning.ts:131
|
Cancels current polling api call and cancels the operation. request.
Returns :
any
the promise of the OperationsClient#cancelOperation api request. |
getOperation |
getOperation()
|
Defined in src/longRunningCalls/longrunning.ts:158
|
Get the updated status of the operation. If the Operation has previously completed, this will use the status of the cached completed operation.
operation result and metadata. The promise resolves to an array where the first element is the unpacked result, the second element is the metadata, and the third element is the raw response of the api call. The promise rejects if the operation returns an error.
Returns :
Promise<literal type>
|
getOperation | ||||||
getOperation(callback: GetOperationCallback)
|
||||||
Defined in src/longRunningCalls/longrunning.ts:159
|
||||||
Parameters :
Returns :
void
|
getOperation | ||||||
getOperation(callback?: GetOperationCallback)
|
||||||
Defined in src/longRunningCalls/longrunning.ts:160
|
||||||
Parameters :
Returns :
Promise | void
|
promise |
promise()
|
Defined in src/longRunningCalls/longrunning.ts:350
|
Wraps the on operation error.
Returns :
any
|
startPolling_ |
startPolling_()
|
Defined in src/longRunningCalls/longrunning.ts:255
|
Poll Note: This method is automatically called once a "complete" event handler is registered on the operation.
Returns :
void
|