Sign in

v1

latestOpenAPI 3.0.12026-07-17235160320.7 KB
Job

Sets a metric for a Job

post/api/v1/jobs/{id}/metrics

Path parameters

idinteger required

ID for the Job resource.

Headers

X-Fieldsstring mask

An optional fields mask

Request body

namestring required

The name of the metric.

valuenumber required

The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string "nan" and infinite values are represented with the strings "inf" and "-inf".

stepinteger

The step value for the metric, optional. Sequentially increasing step values are used to track how a metric changes over time. Indexed from 0. If not provided, defaults to 0.

timestampstring date-time

A timestamp value to associate with the metric. If not provided, defaults to the server time when the metric is received.

Response

Success

namestring required

The name of the metric.

valuenumber required

The value of the metric. Can be a float, NaN, Infinity, or -Infinity. NaN values are represented with the string "nan" and infinite values are represented with the strings "inf" and "-inf".