jobs_metrics

Creates, updates, deletes, gets or lists a jobs_metrics resource.

Overview

Name	jobs_metrics
Type	Resource
Id	google.dataflow.jobs_metrics

Fields

The following fields are returned by SELECT queries:

projects_locations_jobs_get_metrics

Name	Datatype	Description
metricTime	string (google-datetime)	Timestamp as of which metric values are current.
metrics	array	All metrics for this job.

projects_jobs_get_metrics

Name	Datatype	Description
metricTime	string (google-datetime)	Timestamp as of which metric values are current.
metrics	array	All metrics for this job.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_jobs_get_metrics	select	projectId, location, jobId	startTime	Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1. # IAM Permissions Requires the dataflow.metrics.get permission on the job.
projects_jobs_get_metrics	select	projectId, jobId	location, startTime	Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1. # IAM Permissions Requires the dataflow.metrics.get permission on the job.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
jobId	string
location	string
projectId	string
location	string
startTime	string (google-datetime)

SELECT examples

projects_locations_jobs_get_metrics

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

SELECT
metricTime,
metrics
FROM google.dataflow.jobs_metrics
WHERE projectId = '{{ projectId }}' -- required
AND location = '{{ location }}' -- required
AND jobId = '{{ jobId }}' -- required
AND startTime = '{{ startTime }}'
;

projects_jobs_get_metrics

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

SELECT
metricTime,
metrics
FROM google.dataflow.jobs_metrics
WHERE projectId = '{{ projectId }}' -- required
AND jobId = '{{ jobId }}' -- required
AND location = '{{ location }}'
AND startTime = '{{ startTime }}'
;