list method

Future<ListJobMessagesResponse> list(String projectId, String jobId, { String? endTime, String? location, String? minimumImportance, int? pageSize, String? pageToken, String? startTime, String? $fields, })

Request the job status.

To request the status of a job, we recommend using projects.locations.jobs.messages.list with a regional endpoint. Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1.

Request parameters:

projectId - A project id.

jobId - The job to get messages about.

endTime - Return only messages with timestamps < end_time. The default is now (i.e. return up to the latest messages available).

location - The regional endpoint that contains the job specified by job_id.

minimumImportance - Filter to only get messages with importance >= level Possible string values are:

• "JOB_MESSAGE_IMPORTANCE_UNKNOWN" : The message importance isn't specified, or is unknown.
• "JOB_MESSAGE_DEBUG" : The message is at the 'debug' level: typically only useful for software engineers working on the code the job is running. Typically, Dataflow pipeline runners do not display log messages at this level by default.
• "JOB_MESSAGE_DETAILED" : The message is at the 'detailed' level: somewhat verbose, but potentially useful to users. Typically, Dataflow pipeline runners do not display log messages at this level by default. These messages are displayed by default in the Dataflow monitoring UI.
• "JOB_MESSAGE_BASIC" : The message is at the 'basic' level: useful for keeping track of the execution of a Dataflow pipeline. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
• "JOB_MESSAGE_WARNING" : The message is at the 'warning' level: indicating a condition pertaining to a job which may require human intervention. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.
• "JOB_MESSAGE_ERROR" : The message is at the 'error' level: indicating a condition preventing a job from succeeding. Typically, Dataflow pipeline runners display log messages at this level by default, and these messages are displayed by default in the Dataflow monitoring UI.

pageSize - If specified, determines the maximum number of messages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

pageToken - If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

startTime - If specified, return only messages with timestamps >= start_time. The default is the job creation time (i.e. beginning of messages).

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

Completes with a ListJobMessagesResponse.

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<ListJobMessagesResponse> list(
  core.String projectId,
  core.String jobId, {
  core.String? endTime,
  core.String? location,
  core.String? minimumImportance,
  core.int? pageSize,
  core.String? pageToken,
  core.String? startTime,
  core.String? $fields,
}) async {
  final _queryParams = <core.String, core.List<core.String>>{
    if (endTime != null) 'endTime': [endTime],
    if (location != null) 'location': [location],
    if (minimumImportance != null) 'minimumImportance': [minimumImportance],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if (startTime != null) 'startTime': [startTime],
    if ($fields != null) 'fields': [$fields],
  };

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

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