lease method

Future<LeaseWorkItemResponse> lease(
  1. LeaseWorkItemRequest request,
  2. String projectId,
  3. String jobId, {
  4. String? $fields,
})

Leases a dataflow WorkItem to run.

request - The metadata request object.

Request parameters:

projectId - Identifies the project this worker belongs to.

jobId - Identifies the workflow job this worker belongs to.

$fields - Selector specifying which fields to include in a partial response.

Completes with a LeaseWorkItemResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<LeaseWorkItemResponse> lease(
  LeaseWorkItemRequest request,
  core.String projectId,
  core.String jobId, {
  core.String? $fields,
}) async {
  final _body = convert.json.encode(request);
  final _queryParams = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final _url = 'v1b3/projects/' +
      commons.escapeVariable('$projectId') +
      '/jobs/' +
      commons.escapeVariable('$jobId') +
      '/workItems:lease';

  final _response = await _requester.request(
    _url,
    'POST',
    body: _body,
    queryParams: _queryParams,
  );
  return LeaseWorkItemResponse.fromJson(
      _response as core.Map<core.String, core.dynamic>);
}