Method: projects.locations.jobs.messages.list

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.

HTTP request

GET https://dataflow.googleapis.com/v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
projectId

string

A project id.
location

string

The regional endpoint that contains the job specified by jobId.
jobId

string

The job to get messages about.

Query parameters

Parameters
minimumImportance

enum (JobMessageImportance)

Filter to only get messages with importance >= level
pageSize

integer

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

string

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

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListJobMessagesResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/compute
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.