GOgoogle
projects

GET /v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages

Changed on

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.messages.list with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.messages.list is not recommended, as you can only request the status of jobs that are running in us-central1. # IAM Permissions Requires the dataflow.messages.list permission on the job.

Request

  • Base URL
    https://dataflow.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/cloud-platform
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/compute
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/compute
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdstring required

A project id.

locationstring required

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

jobIdstring required

The job to get messages about.

Query parameters

endTimestring google-datetime

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

minimumImportance'JOB_MESSAGE_IMPORTANCE_UNKNOWN' | 'JOB_MESSAGE_DEBUG' | 'JOB_MESSAGE_DETAILED' | 'JOB_MESSAGE_BASIC' | 'JOB_MESSAGE_WARNING' | 'JOB_MESSAGE_ERROR'

Filter to only get messages with importance >= level

pageSizeinteger

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.

pageTokenstring

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.

startTimestring google-datetime

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

Response

Successful response

nextPageTokenstring

The token to obtain the next page of results if there are more.

Changes

  • 69a3fb1fef85Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c

  • e94d44227b2eRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/compute was removed from the endpoint's security scheme Oauth2c