Class google.longrunning.Operations (4.1.3)

Represents an Operations

Inheritance

$protobuf. rpc.Service > google.longrunning.Operations

Package

@google-cloud/speech!

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

  constructor 
 ( 
 rpcImpl 
 : 
  
 $protobuf 
 . 
 RPCImpl 
 , 
  
 requestDelimited 
 ?: 
  
 boolean 
 , 
  
 responseDelimited 
 ?: 
  
 boolean 
 ); 
 

Constructs a new Operations service.

Parameters
Name Description
rpcImpl $protobuf. RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

cancelOperation(request, callback)

  public 
  
 cancelOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 ICancelOperationRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 longrunning 
 . 
 Operations 
 . 
 CancelOperationCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls CancelOperation.

Parameters
Name Description
request ICancelOperationRequest

CancelOperationRequest message or plain object

callback google.longrunning.Operations.CancelOperationCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

cancelOperation(request)

  public 
  
 cancelOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 ICancelOperationRequest 
 ) 
 : 
  
 Promise<google 
 . 
 protobuf 
 . 
 Empty 
> ; 
 

Calls CancelOperation.

Parameter
Name Description
request ICancelOperationRequest

CancelOperationRequest message or plain object

Returns
Type Description
Promise < google.protobuf.Empty >

Promise

create(rpcImpl, requestDelimited, responseDelimited)

  public 
  
 static 
  
 create 
 ( 
 rpcImpl 
 : 
  
 $protobuf 
 . 
 RPCImpl 
 , 
  
 requestDelimited 
 ?: 
  
 boolean 
 , 
  
 responseDelimited 
 ?: 
  
 boolean 
 ) 
 : 
  
 Operations 
 ; 
 

Creates new Operations service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf. RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
Operations

RPC service. Useful where requests and/or responses are streamed.

deleteOperation(request, callback)

  public 
  
 deleteOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IDeleteOperationRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 longrunning 
 . 
 Operations 
 . 
 DeleteOperationCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls DeleteOperation.

Parameters
Name Description
request IDeleteOperationRequest

DeleteOperationRequest message or plain object

callback google.longrunning.Operations.DeleteOperationCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteOperation(request)

  public 
  
 deleteOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IDeleteOperationRequest 
 ) 
 : 
  
 Promise<google 
 . 
 protobuf 
 . 
 Empty 
> ; 
 

Calls DeleteOperation.

Parameter
Name Description
request IDeleteOperationRequest

DeleteOperationRequest message or plain object

Returns
Type Description
Promise < google.protobuf.Empty >

Promise

getOperation(request, callback)

  public 
  
 getOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IGetOperationRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 longrunning 
 . 
 Operations 
 . 
 GetOperationCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls GetOperation.

Parameters
Name Description
request IGetOperationRequest

GetOperationRequest message or plain object

callback google.longrunning.Operations.GetOperationCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

getOperation(request)

  public 
  
 getOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IGetOperationRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls GetOperation.

Parameter
Name Description
request IGetOperationRequest

GetOperationRequest message or plain object

Returns
Type Description
Promise < google.longrunning.Operation >

Promise

listOperations(request, callback)

  public 
  
 listOperations 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IListOperationsRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 longrunning 
 . 
 Operations 
 . 
 ListOperationsCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls ListOperations.

Parameters
Name Description
request IListOperationsRequest

ListOperationsRequest message or plain object

callback google.longrunning.Operations.ListOperationsCallback

Node-style callback called with the error, if any, and ListOperationsResponse

Returns
Type Description
void

listOperations(request)

  public 
  
 listOperations 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IListOperationsRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 ListOperationsResponse 
> ; 
 

Calls ListOperations.

Parameter
Name Description
request IListOperationsRequest

ListOperationsRequest message or plain object

Returns
Type Description
Promise < google.longrunning.ListOperationsResponse >

Promise

waitOperation(request, callback)

  public 
  
 waitOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IWaitOperationRequest 
 , 
  
 callback 
 : 
  
 google 
 . 
 longrunning 
 . 
 Operations 
 . 
 WaitOperationCallback 
 ) 
 : 
  
 void 
 ; 
 

Calls WaitOperation.

Parameters
Name Description
request IWaitOperationRequest

WaitOperationRequest message or plain object

callback google.longrunning.Operations.WaitOperationCallback

Node-style callback called with the error, if any, and Operation

Returns
Type Description
void

waitOperation(request)

  public 
  
 waitOperation 
 ( 
 request 
 : 
  
 google 
 . 
 longrunning 
 . 
 IWaitOperationRequest 
 ) 
 : 
  
 Promise<google 
 . 
 longrunning 
 . 
 Operation 
> ; 
 

Calls WaitOperation.

Parameter
Name Description
request IWaitOperationRequest

WaitOperationRequest message or plain object

Returns
Type Description
Promise < google.longrunning.Operation >

Promise

Create a Mobile Website
View Site in Mobile | Classic
Share by: