Class v1.BatchControllerClient (3.2.0)

The BatchController provides methods to manage batch workloads. v1

Package

Constructors

(constructor)(opts)

  constructor 
 ( 
 opts 
 ?: 
  
 ClientOptions 
 );

Construct an instance of BatchControllerClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

auth

  auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;

batchControllerStub

  batchControllerStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

descriptors

  descriptors 
 : 
  
 Descriptors 
 ;

innerApiCalls

  innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };

operationsClient

  operationsClient 
 : 
  
 gax 
 . 
 OperationsClient 
 ;

pathTemplates

  pathTemplates 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 gax 
 . 
 PathTemplate 
 ; 
  
 };

port

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

The port for this API service.

scopes

  static 
  
 get 
  
 scopes 
 () 
 : 
  
 string 
 [];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

  static 
  
 get 
  
 servicePath 
 () 
 : 
  
 string 
 ;

The DNS address for this API service.

warn

  warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;

Methods

batchPath(project, location, batch)

  batchPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 batch 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified batch resource name string.

Parameters

Name	Description
project	`string`
location	`string`
batch	`string`

Returns

Type	Description
string	{string} Resource name string.

checkCreateBatchProgress(name)

  checkCreateBatchProgress 
 ( 
 name 
 : 
  
 string 
 ) 
 : 
  
 Promise<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 Batch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 BatchOperationMetadata 
>> ;

Check the status of the long running operation returned by createBatch() .

Parameter

Name	Description
name	`string` The operation name that will be passed.

Returns

Type	Description
Promise < LROperation <protos. google.cloud.dataproc.v1.Batch , protos. google.cloud.dataproc.v1.BatchOperationMetadata >>	{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

   
 /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The parent resource where this batch will be created. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. The batch to create. 
 */ 
  
 // const batch = {} 
  
 /** 
 *  Optional. The ID to use for the batch, which will become the final component of 
 *  the batch's resource name. 
 *  This value must be 4-63 characters. Valid characters are `/[a-z][0-9]-/`. 
 */ 
  
 // const batchId = 'abc123' 
  
 /** 
 *  Optional. A unique ID used to identify the request. If the service 
 *  receives two 
 *  CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s 
 *  with the same request_id, the second request is ignored and the 
 *  Operation that corresponds to the first Batch created and stored 
 *  in the backend is returned. 
 *  Recommendation: Set this value to a 
 *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier). 
 *  The value must contain only letters (a-z, A-Z), numbers (0-9), 
 *  underscores (_), and hyphens (-). The maximum length is 40 characters. 
 */ 
  
 // const requestId = 'abc123' 
  
 // Imports the Dataproc library 
  
 const 
  
 { 
 BatchControllerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dataproc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataprocClient 
  
 = 
  
 new 
  
  BatchControllerClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateBatch 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 batch 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 dataprocClient 
 . 
 createBatch 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 promise 
 (); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCreateBatch 
 ();

close()

  close 
 () 
 : 
  
 Promise<void> 
 ;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise <void>	{Promise} A promise that resolves when the client is closed.

createBatch(request, options)

  createBatch 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 ICreateBatchRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatchOperationMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Creates a batch workload that executes asynchronously.

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.ICreateBatchRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ LROperation <protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IBatchOperationMetadata >, protos. google.longrunning.IOperation \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its `promise()` method returns a promise you can `await` for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

   
 /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The parent resource where this batch will be created. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. The batch to create. 
 */ 
  
 // const batch = {} 
  
 /** 
 *  Optional. The ID to use for the batch, which will become the final component of 
 *  the batch's resource name. 
 *  This value must be 4-63 characters. Valid characters are `/[a-z][0-9]-/`. 
 */ 
  
 // const batchId = 'abc123' 
  
 /** 
 *  Optional. A unique ID used to identify the request. If the service 
 *  receives two 
 *  CreateBatchRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateBatchRequest)s 
 *  with the same request_id, the second request is ignored and the 
 *  Operation that corresponds to the first Batch created and stored 
 *  in the backend is returned. 
 *  Recommendation: Set this value to a 
 *  UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier). 
 *  The value must contain only letters (a-z, A-Z), numbers (0-9), 
 *  underscores (_), and hyphens (-). The maximum length is 40 characters. 
 */ 
  
 // const requestId = 'abc123' 
  
 // Imports the Dataproc library 
  
 const 
  
 { 
 BatchControllerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dataproc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataprocClient 
  
 = 
  
 new 
  
  BatchControllerClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateBatch 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 batch 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 [ 
 operation 
 ] 
  
 = 
  
 await 
  
 dataprocClient 
 . 
 createBatch 
 ( 
 request 
 ); 
  
 const 
  
 [ 
 response 
 ] 
  
 = 
  
 await 
  
 operation 
 . 
 promise 
 (); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCreateBatch 
 ();

createBatch(request, options, callback)

  createBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 ICreateBatchRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatchOperationMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.ICreateBatchRequest`
options	`CallOptions`
callback	`Callback < LROperation <protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IBatchOperationMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createBatch(request, callback)

  createBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 ICreateBatchRequest 
 , 
  
 callback 
 : 
  
 Callback<LROperation<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatchOperationMetadata 
> , 
  
 protos 
 . 
 google 
 . 
 longrunning 
 . 
 IOperation 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.ICreateBatchRequest`
callback	`Callback < LROperation <protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IBatchOperationMetadata >, protos. google.longrunning.IOperation \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteBatch(request, options)

  deleteBatch 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION .

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IDeleteBatchRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[protos. google.protobuf.IEmpty , protos. google.cloud.dataproc.v1.IDeleteBatchRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

   
 /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The name of the batch resource to delete. 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Dataproc library 
  
 const 
  
 { 
 BatchControllerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dataproc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataprocClient 
  
 = 
  
 new 
  
  BatchControllerClient 
 
 (); 
  
 async 
  
 function 
  
 callDeleteBatch 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataprocClient 
 . 
 deleteBatch 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callDeleteBatch 
 ();

deleteBatch(request, options, callback)

  deleteBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IDeleteBatchRequest`
options	`CallOptions`
callback	`Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dataproc.v1.IDeleteBatchRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteBatch(request, callback)

  deleteBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IDeleteBatchRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IDeleteBatchRequest`
callback	`Callback <protos. google.protobuf.IEmpty , protos. google.cloud.dataproc.v1.IDeleteBatchRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBatch(request, options)

  getBatch 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
 ]>;

Gets the batch workload resource representation.

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IGetBatchRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IGetBatchRequest \| undefined, {} \| undefined]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Batch]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

   
 /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The name of the batch to retrieve. 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Dataproc library 
  
 const 
  
 { 
 BatchControllerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dataproc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataprocClient 
  
 = 
  
 new 
  
  BatchControllerClient 
 
 (); 
  
 async 
  
 function 
  
 callGetBatch 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 dataprocClient 
 . 
 getBatch 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callGetBatch 
 ();

getBatch(request, options, callback)

  getBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IGetBatchRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IGetBatchRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getBatch(request, callback)

  getBatch 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IGetBatchRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IGetBatchRequest`
callback	`Callback <protos. google.cloud.dataproc.v1.IBatch , protos. google.cloud.dataproc.v1.IGetBatchRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getProjectId()

  getProjectId 
 () 
 : 
  
 Promise<string> 
 ;

Returns

Type	Description
Promise <string>

getProjectId(callback)

  getProjectId 
 ( 
 callback 
 : 
  
 Callback<string 
 , 
  
 undefined 
 , 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameter

Name	Description
callback	`Callback <string, undefined, undefined>`

Returns

Type	Description
void

initialize()

  initialize 
 () 
 : 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise <{ [name: string]: Function ; }>	{Promise} A promise that resolves to an authenticated service stub.

listBatches(request, options)

  listBatches 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesResponse 
 ]>;

Lists batch workloads.

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IListBatchesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise <[protos. google.cloud.dataproc.v1.IBatch [], protos. google.cloud.dataproc.v1.IListBatchesRequest | null, protos. google.cloud.dataproc.v1.IListBatchesResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [Batch]. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listBatchesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listBatches(request, options, callback)

  listBatches 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IListBatchesRequest`
options	`CallOptions`
callback	`PaginationCallback <protos. google.cloud.dataproc.v1.IListBatchesRequest , protos. google.cloud.dataproc.v1.IListBatchesResponse \| null \| undefined, protos. google.cloud.dataproc.v1.IBatch >`

Returns

Type	Description
void

listBatches(request, callback)

  listBatches 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IListBatchesRequest`
callback	`PaginationCallback <protos. google.cloud.dataproc.v1.IListBatchesRequest , protos. google.cloud.dataproc.v1.IListBatchesResponse \| null \| undefined, protos. google.cloud.dataproc.v1.IBatch >`

Returns

Type	Description
void

listBatchesAsync(request, options)

  listBatchesAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IBatch 
> ;

Equivalent to listBatches , but returns an iterable object.

for - await - of syntax is used with the iterable to get response elements on-demand.

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IListBatchesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable <protos. google.cloud.dataproc.v1.IBatch >

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Batch]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

   
 /** 
 * TODO(developer): Uncomment these variables before running the sample. 
 */ 
  
 /** 
 *  Required. The parent, which owns this collection of batches. 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Optional. The maximum number of batches to return in each response. 
 *  The service may return fewer than this value. 
 *  The default page size is 20; the maximum page size is 1000. 
 */ 
  
 // const pageSize = 1234 
  
 /** 
 *  Optional. A page token received from a previous `ListBatches` call. 
 *  Provide this token to retrieve the subsequent page. 
 */ 
  
 // const pageToken = 'abc123' 
  
 // Imports the Dataproc library 
  
 const 
  
 { 
 BatchControllerClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/dataproc 
' 
 ). 
 v1 
 ; 
  
 // Instantiates a client 
  
 const 
  
 dataprocClient 
  
 = 
  
 new 
  
  BatchControllerClient 
 
 (); 
  
 async 
  
 function 
  
 callListBatches 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 iterable 
  
 = 
  
 await 
  
 dataprocClient 
 . 
  listBatchesAsync 
 
 ( 
 request 
 ); 
  
 for 
  
 await 
  
 ( 
 const 
  
 response 
  
 of 
  
 iterable 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 } 
  
 callListBatches 
 ();

listBatchesStream(request, options)

  listBatchesStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 dataproc 
 . 
 v1 
 . 
 IListBatchesRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

Equivalent to method.name.toCamelCase() , but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos. google.cloud.dataproc.v1.IListBatchesRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Batch] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listBatchesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

  locationPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified location resource name string.

Parameters

Name	Description
project	`string`
location	`string`

Returns

Type	Description
string	{string} Resource name string.

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

  matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName 
 ( 
 projectLocationAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the autoscaling_policy from ProjectLocationAutoscalingPolicy resource.

Parameter

Name	Description
projectLocationAutoscalingPolicyName	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the autoscaling_policy.

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

  matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName 
 ( 
 projectRegionAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the autoscaling_policy from ProjectRegionAutoscalingPolicy resource.

Parameter

Name	Description
projectRegionAutoscalingPolicyName	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the autoscaling_policy.

matchBatchFromBatchName(batchName)

  matchBatchFromBatchName 
 ( 
 batchName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the batch from Batch resource.

Parameter

Name	Description
batchName	`string` A fully-qualified path representing Batch resource.

Returns

Type	Description
string \| number	{string} A string representing the batch.

matchLocationFromBatchName(batchName)

  matchLocationFromBatchName 
 ( 
 batchName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from Batch resource.

Parameter

Name	Description
batchName	`string` A fully-qualified path representing Batch resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromLocationName(locationName)

  matchLocationFromLocationName 
 ( 
 locationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

  matchLocationFromProjectLocationAutoscalingPolicyName 
 ( 
 projectLocationAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from ProjectLocationAutoscalingPolicy resource.

Parameter

Name	Description
projectLocationAutoscalingPolicyName	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

  matchLocationFromProjectLocationWorkflowTemplateName 
 ( 
 projectLocationWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the location from ProjectLocationWorkflowTemplate resource.

Parameter

Name	Description
projectLocationWorkflowTemplateName	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchProjectFromBatchName(batchName)

  matchProjectFromBatchName 
 ( 
 batchName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Batch resource.

Parameter

Name	Description
batchName	`string` A fully-qualified path representing Batch resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromLocationName(locationName)

  matchProjectFromLocationName 
 ( 
 locationName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Location resource.

Parameter

Name	Description
locationName	`string` A fully-qualified path representing Location resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

  matchProjectFromProjectLocationAutoscalingPolicyName 
 ( 
 projectLocationAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from ProjectLocationAutoscalingPolicy resource.

Parameter

Name	Description
projectLocationAutoscalingPolicyName	`string` A fully-qualified path representing project_location_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

  matchProjectFromProjectLocationWorkflowTemplateName 
 ( 
 projectLocationWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from ProjectLocationWorkflowTemplate resource.

Parameter

Name	Description
projectLocationWorkflowTemplateName	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectName(projectName)

  matchProjectFromProjectName 
 ( 
 projectName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from Project resource.

Parameter

Name	Description
projectName	`string` A fully-qualified path representing Project resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

  matchProjectFromProjectRegionAutoscalingPolicyName 
 ( 
 projectRegionAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from ProjectRegionAutoscalingPolicy resource.

Parameter

Name	Description
projectRegionAutoscalingPolicyName	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

  matchProjectFromProjectRegionWorkflowTemplateName 
 ( 
 projectRegionWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the project from ProjectRegionWorkflowTemplate resource.

Parameter

Name	Description
projectRegionWorkflowTemplateName	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

  matchRegionFromProjectRegionAutoscalingPolicyName 
 ( 
 projectRegionAutoscalingPolicyName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the region from ProjectRegionAutoscalingPolicy resource.

Parameter

Name	Description
projectRegionAutoscalingPolicyName	`string` A fully-qualified path representing project_region_autoscaling_policy resource.

Returns

Type	Description
string \| number	{string} A string representing the region.

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

  matchRegionFromProjectRegionWorkflowTemplateName 
 ( 
 projectRegionWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the region from ProjectRegionWorkflowTemplate resource.

Parameter

Name	Description
projectRegionWorkflowTemplateName	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the region.

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

  matchWorkflowTemplateFromProjectLocationWorkflowTemplateName 
 ( 
 projectLocationWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the workflow_template from ProjectLocationWorkflowTemplate resource.

Parameter

Name	Description
projectLocationWorkflowTemplateName	`string` A fully-qualified path representing project_location_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the workflow_template.

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

  matchWorkflowTemplateFromProjectRegionWorkflowTemplateName 
 ( 
 projectRegionWorkflowTemplateName 
 : 
  
 string 
 ) 
 : 
  
 string 
  
 | 
  
 number 
 ;

Parse the workflow_template from ProjectRegionWorkflowTemplate resource.

Parameter

Name	Description
projectRegionWorkflowTemplateName	`string` A fully-qualified path representing project_region_workflow_template resource.

Returns

Type	Description
string \| number	{string} A string representing the workflow_template.

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

  projectLocationAutoscalingPolicyPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 autoscalingPolicy 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified projectLocationAutoscalingPolicy resource name string.

Parameters

Name	Description
project	`string`
location	`string`
autoscalingPolicy	`string`

Returns

Type	Description
string	{string} Resource name string.

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

  projectLocationWorkflowTemplatePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 location 
 : 
  
 string 
 , 
  
 workflowTemplate 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified projectLocationWorkflowTemplate resource name string.

Parameters

Name	Description
project	`string`
location	`string`
workflowTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

projectPath(project)

  projectPath 
 ( 
 project 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified project resource name string.

Parameter

Name	Description
project	`string`

Returns

Type	Description
string	{string} Resource name string.

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

  projectRegionAutoscalingPolicyPath 
 ( 
 project 
 : 
  
 string 
 , 
  
 region 
 : 
  
 string 
 , 
  
 autoscalingPolicy 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified projectRegionAutoscalingPolicy resource name string.

Parameters

Name	Description
project	`string`
region	`string`
autoscalingPolicy	`string`

Returns

Type	Description
string	{string} Resource name string.

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

  projectRegionWorkflowTemplatePath 
 ( 
 project 
 : 
  
 string 
 , 
  
 region 
 : 
  
 string 
 , 
  
 workflowTemplate 
 : 
  
 string 
 ) 
 : 
  
 string 
 ;

Return a fully-qualified projectRegionWorkflowTemplate resource name string.

Parameters

Name	Description
project	`string`
region	`string`
workflowTemplate	`string`

Returns

Type	Description
string	{string} Resource name string.

Class v1.BatchControllerClient (3.2.0) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts)

Properties

apiEndpoint

auth

batchControllerStub

descriptors

innerApiCalls

operationsClient

pathTemplates

port

scopes

servicePath

warn

Methods

batchPath(project, location, batch)

checkCreateBatchProgress(name)

close()

createBatch(request, options)

createBatch(request, options, callback)

createBatch(request, callback)

deleteBatch(request, options)

deleteBatch(request, options, callback)

deleteBatch(request, callback)

getBatch(request, options)

getBatch(request, options, callback)

getBatch(request, callback)

getProjectId()

getProjectId(callback)

initialize()

listBatches(request, options)

listBatches(request, options, callback)

listBatches(request, callback)

listBatchesAsync(request, options)

listBatchesStream(request, options)

locationPath(project, location)

matchAutoscalingPolicyFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchAutoscalingPolicyFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchBatchFromBatchName(batchName)

matchLocationFromBatchName(batchName)

matchLocationFromLocationName(locationName)

matchLocationFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchLocationFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromBatchName(batchName)

matchProjectFromLocationName(locationName)

matchProjectFromProjectLocationAutoscalingPolicyName(projectLocationAutoscalingPolicyName)

matchProjectFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchProjectFromProjectName(projectName)

matchProjectFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchProjectFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchRegionFromProjectRegionAutoscalingPolicyName(projectRegionAutoscalingPolicyName)

matchRegionFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

matchWorkflowTemplateFromProjectLocationWorkflowTemplateName(projectLocationWorkflowTemplateName)

matchWorkflowTemplateFromProjectRegionWorkflowTemplateName(projectRegionWorkflowTemplateName)

projectLocationAutoscalingPolicyPath(project, location, autoscalingPolicy)

projectLocationWorkflowTemplatePath(project, location, workflowTemplate)

projectPath(project)

projectRegionAutoscalingPolicyPath(project, region, autoscalingPolicy)

projectRegionWorkflowTemplatePath(project, region, workflowTemplate)

Class v1.BatchControllerClient (3.2.0)