Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class TimeSeries.
The metrics object for a SubTask.
Generated from protobuf messagegoogle.cloud.bigquery.migration.v2.TimeSeries
Namespace
Google \ Cloud \ BigQuery \ Migration \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ metric
string
Required. The name of the metric. If the metric is not known by the service yet, it will be auto-created.
↳ value_type
int
Required. The value type of the time series.
↳ metric_kind
int
Optional. The metric kind of the time series. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be eitherGAUGE(the default) orCUMULATIVE.
Required. The data points of this time series. When listing time series, points are returned in reverse time order. When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must beBOOL,INT64,DOUBLE, orDISTRIBUTION.
getMetric
Required. The name of the metric.
If the metric is not known by the service yet, it will be auto-created.
Returns
Type
Description
string
setMetric
Required. The name of the metric.
If the metric is not known by the service yet, it will be auto-created.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getValueType
Required. The value type of the time series.
Returns
Type
Description
int
setValueType
Required. The value type of the time series.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMetricKind
Optional. The metric kind of the time series.
If present, it must be the same as the metric kind of the associated
metric. If the associated metric's descriptor must be auto-created, then
this field specifies the metric kind of the new descriptor and must be
eitherGAUGE(the default) orCUMULATIVE.
Returns
Type
Description
int
setMetricKind
Optional. The metric kind of the time series.
If present, it must be the same as the metric kind of the associated
metric. If the associated metric's descriptor must be auto-created, then
this field specifies the metric kind of the new descriptor and must be
eitherGAUGE(the default) orCUMULATIVE.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPoints
Required. The data points of this time series. When listing time series,
points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must beBOOL,INT64,DOUBLE, orDISTRIBUTION.
Required. The data points of this time series. When listing time series,
points are returned in reverse time order.
When creating a time series, this field must contain exactly one point and
the point's type must be the same as the value type of the associated
metric. If the associated metric's descriptor must be auto-created, then
the value type of the descriptor is determined by the point's type, which
must beBOOL,INT64,DOUBLE, orDISTRIBUTION.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud BigQuery Migration V2 Client - Class TimeSeries (1.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.5 (latest)](/php/docs/reference/cloud-bigquery-migration/latest/V2.TimeSeries)\n- [1.1.4](/php/docs/reference/cloud-bigquery-migration/1.1.4/V2.TimeSeries)\n- [1.0.0](/php/docs/reference/cloud-bigquery-migration/1.0.0/V2.TimeSeries)\n- [0.4.5](/php/docs/reference/cloud-bigquery-migration/0.4.5/V2.TimeSeries)\n- [0.3.3](/php/docs/reference/cloud-bigquery-migration/0.3.3/V2.TimeSeries)\n- [0.2.2](/php/docs/reference/cloud-bigquery-migration/0.2.2/V2.TimeSeries)\n- [0.1.4](/php/docs/reference/cloud-bigquery-migration/0.1.4/V2.TimeSeries) \nReference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class TimeSeries.\n\nThe metrics object for a SubTask.\n\nGenerated from protobuf message `google.cloud.bigquery.migration.v2.TimeSeries`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Migration \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMetric\n\nRequired. The name of the metric.\n\nIf the metric is not known by the service yet, it will be auto-created.\n\n### setMetric\n\nRequired. The name of the metric.\n\nIf the metric is not known by the service yet, it will be auto-created.\n\n### getValueType\n\nRequired. The value type of the time series.\n\n### setValueType\n\nRequired. The value type of the time series.\n\n### getMetricKind\n\nOptional. The metric kind of the time series.\n\nIf present, it must be the same as the metric kind of the associated\nmetric. If the associated metric's descriptor must be auto-created, then\nthis field specifies the metric kind of the new descriptor and must be\neither `GAUGE` (the default) or `CUMULATIVE`.\n\n### setMetricKind\n\nOptional. The metric kind of the time series.\n\nIf present, it must be the same as the metric kind of the associated\nmetric. If the associated metric's descriptor must be auto-created, then\nthis field specifies the metric kind of the new descriptor and must be\neither `GAUGE` (the default) or `CUMULATIVE`.\n\n### getPoints\n\nRequired. The data points of this time series. When listing time series,\npoints are returned in reverse time order.\n\nWhen creating a time series, this field must contain exactly one point and\nthe point's type must be the same as the value type of the associated\nmetric. If the associated metric's descriptor must be auto-created, then\nthe value type of the descriptor is determined by the point's type, which\nmust be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`.\n\n### setPoints\n\nRequired. The data points of this time series. When listing time series,\npoints are returned in reverse time order.\n\nWhen creating a time series, this field must contain exactly one point and\nthe point's type must be the same as the value type of the associated\nmetric. If the associated metric's descriptor must be auto-created, then\nthe value type of the descriptor is determined by the point's type, which\nmust be `BOOL`, `INT64`, `DOUBLE`, or `DISTRIBUTION`."]]
