Google Batch Service. The service manages user submitted batch jobs and allocates Google Compute Engine VM instances to run the jobs. v1
Package
@google-cloud/batchConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of BatchServiceClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new BatchServiceClient({fallback: 'rest'}, gax); ```
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
auth
auth
:
gax
.
GoogleAuth
;
batchServiceStub
batchServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
locationsClient
locationsClient
:
LocationsClient
;
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
cancelOperation(request, options, callback)
cancelOperation
(
request
:
protos
.
google
.
longrunning
.
CancelOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
CancelOperationRequest
,
{}
|
undefined
|
null
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
CancelOperationRequest
,
protos
.
google
.
protobuf
.
Empty
,
{}
|
undefined
|
null
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.CancelOperationRequest
, {} | undefined | null>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.CancelOperationRequest
, protos.google.protobuf.Empty
, {} | undefined | null>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
cancelOperation
({
name
:
''
});
checkDeleteJobProgress(name)
checkDeleteJobProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
cloud
.
batch
.
v1
.
OperationMetadata
>> ;
Check the status of the long running operation returned by deleteJob()
.
name
string
The operation name that will be passed.
Promise
< LROperation
< protos.google.protobuf.Empty
, protos.google.cloud.batch.v1.OperationMetadata
>>
{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 for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Job name.
*/
// const name = 'abc123'
/**
* Optional. Reason for this deletion.
*/
// const reason = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callDeleteJob
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
batchClient
.
deleteJob
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteJob
();
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
createJob(request, options)
createJob
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
|
undefined
,
{}
|
undefined
]>;
Create a Job.
request
options
Promise
<[ protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.ICreateJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Job . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The parent resource name where the Job will be created.
* Pattern: "projects/{project}/locations/{location}"
*/
// const parent = 'abc123'
/**
* ID used to uniquely identify the Job within its parent scope.
* This field should contain at most 63 characters and must start with
* lowercase characters.
* Only lowercase characters, numbers and '-' are accepted.
* The '-' character cannot be the first or the last one.
* A system generated ID will be used if the field is not set.
* The job.name field in the request will be ignored and the created resource
* name of the Job will be "{parent}/jobs/{job_id}".
*/
// const jobId = 'abc123'
/**
* Required. The Job to create.
*/
// const job = {}
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes since the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callCreateJob
()
{
// Construct request
const
request
=
{
parent
,
job
,
};
// Run request
const
response
=
await
batchClient
.
createJob
(
request
);
console
.
log
(
response
);
}
callCreateJob
();
createJob(request, options, callback)
createJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.ICreateJobRequest
| null | undefined, {} | null | undefined>
void
createJob(request, callback)
createJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
ICreateJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.ICreateJobRequest
| null | undefined, {} | null | undefined>
void
deleteJob(request, options)
deleteJob
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IDeleteJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
batch
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
undefined
,
{}
|
undefined
]>;
Delete a Job.
request
options
Promise
<[ LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.batch.v1.IOperationMetadata
>, 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
for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Job name.
*/
// const name = 'abc123'
/**
* Optional. Reason for this deletion.
*/
// const reason = 'abc123'
/**
* Optional. An optional request ID to identify requests. Specify a unique
* request ID so that if you must retry your request, the server will know to
* ignore the request if it has already been completed. The server will
* guarantee that for at least 60 minutes after the first request.
* For example, consider a situation where you make an initial request and
* the request times out. If you make the request again with the same request
* ID, the server can check if original operation with the same request ID
* was received, and if so, will ignore the second request. This prevents
* clients from accidentally creating duplicate commitments.
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
*/
// const requestId = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callDeleteJob
()
{
// Construct request
const
request
=
{
};
// Run request
const
[
operation
]
=
await
batchClient
.
deleteJob
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callDeleteJob
();
deleteJob(request, options, callback)
deleteJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IDeleteJobRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
batch
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.batch.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteJob(request, callback)
deleteJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IDeleteJobRequest
,
callback
:
Callback<LROperation<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
batch
.
v1
.
IOperationMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< LROperation
< protos.google.protobuf.IEmpty
, protos.google.cloud.batch.v1.IOperationMetadata
>, protos.google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
request
options
CallOptions
| Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.protobuf.Empty
, protos.google.longrunning.DeleteOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
await
client
.
deleteOperation
({
name
:
''
});
getJob(request, options)
getJob
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
|
undefined
,
{}
|
undefined
]>;
Get a Job specified by its resource name.
request
options
Promise
<[ protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.IGetJobRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Job . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Job name.
*/
// const name = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callGetJob
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
batchClient
.
getJob
(
request
);
console
.
log
(
response
);
}
callGetJob
();
getJob(request, options, callback)
getJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.IGetJobRequest
| null | undefined, {} | null | undefined>
void
getJob(request, callback)
getJob
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
IJob
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetJobRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.batch.v1.IJob
, protos.google.cloud.batch.v1.IGetJobRequest
| null | undefined, {} | null | undefined>
void
getLocation(request, options, callback)
getLocation
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
,
options
?:
gax
.
CallOptions
|
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<LocationProtos
.
google
.
cloud
.
location
.
ILocation
,
LocationProtos
.
google
.
cloud
.
location
.
IGetLocationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
Promise<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Gets information about a location.
request
LocationProtos.google.cloud.location.IGetLocationRequest
The request object that will be sent.
options
CallOptions
| Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Call options. See CallOptions for more details.
callback
Callback
< google.cloud.location.ILocation
, google.cloud.location.IGetLocationRequest
| null | undefined, {} | null | undefined>
Promise
< google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
const
[
response
]
=
await
client
.
getLocation
(
request
);
getOperation(request, options, callback)
getOperation
(
request
:
protos
.
google
.
longrunning
.
GetOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
longrunning
.
Operation
,
protos
.
google
.
longrunning
.
GetOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise
< [
protos
.
google
.
longrunning
.
Operation
]>;
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
request
options
CallOptions
| Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback
Callback
< protos.google.longrunning.Operation
, protos.google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getTask(request, options)
getTask
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
batch
.
v1
.
ITask
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
|
undefined
,
{}
|
undefined
]>;
Return a single Task.
request
options
Promise
<[ protos.google.cloud.batch.v1.ITask
, protos.google.cloud.batch.v1.IGetTaskRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing Task . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Task name.
*/
// const name = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callGetTask
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
batchClient
.
getTask
(
request
);
console
.
log
(
response
);
}
callGetTask
();
getTask(request, options, callback)
getTask
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
ITask
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.batch.v1.ITask
, protos.google.cloud.batch.v1.IGetTaskRequest
| null | undefined, {} | null | undefined>
void
getTask(request, callback)
getTask
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
batch
.
v1
.
ITask
,
protos
.
google
.
cloud
.
batch
.
v1
.
IGetTaskRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.batch.v1.ITask
, protos.google.cloud.batch.v1.IGetTaskRequest
| null | undefined, {} | null | undefined>
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.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
jobPath(project, location, job)
jobPath
(
project
:
string
,
location
:
string
,
job
:
string
)
:
string
;
Return a fully-qualified job resource name string.
project
string
location
string
job
string
string
{string} Resource name string.
listJobs(request, options)
listJobs
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
batch
.
v1
.
IJob
[],
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
|
null
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsResponse
]>;
List all Jobs for a project within a region.
request
options
Promise
<[ protos.google.cloud.batch.v1.IJob
[], protos.google.cloud.batch.v1.IListJobsRequest
| null, protos.google.cloud.batch.v1.IListJobsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Job
. 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 listJobsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listJobs(request, options, callback)
listJobs
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
batch
.
v1
.
IJob
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.batch.v1.IListJobsRequest
, protos.google.cloud.batch.v1.IListJobsResponse
| null | undefined, protos.google.cloud.batch.v1.IJob
>
void
listJobs(request, callback)
listJobs
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
batch
.
v1
.
IJob
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.batch.v1.IListJobsRequest
, protos.google.cloud.batch.v1.IListJobsResponse
| null | undefined, protos.google.cloud.batch.v1.IJob
>
void
listJobsAsync(request, options)
listJobsAsync
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
batch
.
v1
.
IJob
> ;
Equivalent to listJobs
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.batch.v1.IJob
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Job . 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 for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Parent path.
*/
// const parent = 'abc123'
/**
* List filter.
*/
// const filter = 'abc123'
/**
* Optional. Sort results. Supported are "name", "name desc", "create_time",
* and "create_time desc".
*/
// const orderBy = 'abc123'
/**
* Page size.
*/
// const pageSize = 1234
/**
* Page token.
*/
// const pageToken = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callListJobs
()
{
// Construct request
const
request
=
{
};
// Run request
const
iterable
=
await
batchClient
.
listJobsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListJobs
();
listJobsStream(request, options)
listJobsStream
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListJobsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Job
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 listJobsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listLocationsAsync(request, options)
listLocationsAsync
(
request
:
LocationProtos
.
google
.
cloud
.
location
.
IListLocationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<LocationProtos
.
google
.
cloud
.
location
.
ILocation
> ;
Lists information about the supported locations for this service. Returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
LocationProtos.google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
AsyncIterable
< google.cloud.location.ILocation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . 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 for more details and examples.
const
iterable
=
client
.
listLocationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
// process response
}
listOperationsAsync(request, options)
listOperationsAsync
(
request
:
protos
.
google
.
longrunning
.
ListOperationsRequest
,
options
?:
gax
.
CallOptions
)
:
AsyncIterable<protos
.
google
.
longrunning
.
ListOperationsResponse
> ;
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
. Returns an iterable object.
For-await-of syntax is used with the iterable to recursively get response element on-demand.
request
options
CallOptions
Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
AsyncIterable
< protos.google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
listTasks(request, options)
listTasks
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
batch
.
v1
.
ITask
[],
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
|
null
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksResponse
]>;
List Tasks associated with a job.
request
options
Promise
<[ protos.google.cloud.batch.v1.ITask
[], protos.google.cloud.batch.v1.IListTasksRequest
| null, protos.google.cloud.batch.v1.IListTasksResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of Task
. 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 listTasksAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listTasks(request, options, callback)
listTasks
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
batch
.
v1
.
ITask
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.batch.v1.IListTasksRequest
, protos.google.cloud.batch.v1.IListTasksResponse
| null | undefined, protos.google.cloud.batch.v1.ITask
>
void
listTasks(request, callback)
listTasks
(
request
:
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
batch
.
v1
.
ITask
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.batch.v1.IListTasksRequest
, protos.google.cloud.batch.v1.IListTasksResponse
| null | undefined, protos.google.cloud.batch.v1.ITask
>
void
listTasksAsync(request, options)
listTasksAsync
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
batch
.
v1
.
ITask
> ;
Equivalent to listTasks
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.batch.v1.ITask
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing Task . 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 for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of a TaskGroup from which Tasks are being requested.
* Pattern:
* "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}"
*/
// const parent = 'abc123'
/**
* Task filter, null filter matches all Tasks.
* Filter string should be of the format State=TaskStatus.State e.g.
* State=RUNNING
*/
// const filter = 'abc123'
/**
* Page size.
*/
// const pageSize = 1234
/**
* Page token.
*/
// const pageToken = 'abc123'
// Imports the Batch library
const
{
BatchServiceClient
}
=
require
(
' @google-cloud/batch
'
).
v1
;
// Instantiates a client
const
batchClient
=
new
BatchServiceClient
();
async
function
callListTasks
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
await
batchClient
.
listTasksAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListTasks
();
listTasksStream(request, options)
listTasksStream
(
request
?:
protos
.
google
.
cloud
.
batch
.
v1
.
IListTasksRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing Task
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 listTasksAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
locationPath(project, location)
locationPath
(
project
:
string
,
location
:
string
)
:
string
;
Return a fully-qualified location resource name string.
project
string
location
string
string
{string} Resource name string.
matchJobFromJobName(jobName)
matchJobFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the job from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the job.
matchJobFromTaskGroupName(taskGroupName)
matchJobFromTaskGroupName
(
taskGroupName
:
string
)
:
string
|
number
;
Parse the job from TaskGroup resource.
taskGroupName
string
A fully-qualified path representing TaskGroup resource.
string | number
{string} A string representing the job.
matchJobFromTaskName(taskName)
matchJobFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the job from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the job.
matchLocationFromJobName(jobName)
matchLocationFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the location from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the location.
matchLocationFromLocationName(locationName)
matchLocationFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the location from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the location.
matchLocationFromTaskGroupName(taskGroupName)
matchLocationFromTaskGroupName
(
taskGroupName
:
string
)
:
string
|
number
;
Parse the location from TaskGroup resource.
taskGroupName
string
A fully-qualified path representing TaskGroup resource.
string | number
{string} A string representing the location.
matchLocationFromTaskName(taskName)
matchLocationFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the location from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the location.
matchProjectFromJobName(jobName)
matchProjectFromJobName
(
jobName
:
string
)
:
string
|
number
;
Parse the project from Job resource.
jobName
string
A fully-qualified path representing Job resource.
string | number
{string} A string representing the project.
matchProjectFromLocationName(locationName)
matchProjectFromLocationName
(
locationName
:
string
)
:
string
|
number
;
Parse the project from Location resource.
locationName
string
A fully-qualified path representing Location resource.
string | number
{string} A string representing the project.
matchProjectFromProjectName(projectName)
matchProjectFromProjectName
(
projectName
:
string
)
:
string
|
number
;
Parse the project from Project resource.
projectName
string
A fully-qualified path representing Project resource.
string | number
{string} A string representing the project.
matchProjectFromTaskGroupName(taskGroupName)
matchProjectFromTaskGroupName
(
taskGroupName
:
string
)
:
string
|
number
;
Parse the project from TaskGroup resource.
taskGroupName
string
A fully-qualified path representing TaskGroup resource.
string | number
{string} A string representing the project.
matchProjectFromTaskName(taskName)
matchProjectFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the project from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the project.
matchTaskFromTaskName(taskName)
matchTaskFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the task from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the task.
matchTaskGroupFromTaskGroupName(taskGroupName)
matchTaskGroupFromTaskGroupName
(
taskGroupName
:
string
)
:
string
|
number
;
Parse the task_group from TaskGroup resource.
taskGroupName
string
A fully-qualified path representing TaskGroup resource.
string | number
{string} A string representing the task_group.
matchTaskGroupFromTaskName(taskName)
matchTaskGroupFromTaskName
(
taskName
:
string
)
:
string
|
number
;
Parse the task_group from Task resource.
taskName
string
A fully-qualified path representing Task resource.
string | number
{string} A string representing the task_group.
projectPath(project)
projectPath
(
project
:
string
)
:
string
;
Return a fully-qualified project resource name string.
project
string
string
{string} Resource name string.
taskGroupPath(project, location, job, taskGroup)
taskGroupPath
(
project
:
string
,
location
:
string
,
job
:
string
,
taskGroup
:
string
)
:
string
;
Return a fully-qualified taskGroup resource name string.
project
string
location
string
job
string
taskGroup
string
string
{string} Resource name string.
taskPath(project, location, job, taskGroup, task)
taskPath
(
project
:
string
,
location
:
string
,
job
:
string
,
taskGroup
:
string
,
task
:
string
)
:
string
;
Return a fully-qualified task resource name string.
project
string
location
string
job
string
taskGroup
string
task
string
string
{string} Resource name string.
