Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class TimeSeries.
The metrics object for a SubTask.
Generated from protobuf message google.cloud.bigquery.migration.v2.TimeSeries
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 either |
↳ points |
array<Google\Cloud\BigQuery\Migration\V2\Point>
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 be |
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
either GAUGE (the default) or CUMULATIVE.
| 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
either GAUGE (the default) or CUMULATIVE.
| 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 be BOOL, INT64, DOUBLE, or DISTRIBUTION.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setPoints
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 be BOOL, INT64, DOUBLE, or DISTRIBUTION.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\BigQuery\Migration\V2\Point>
|
| Returns | |
|---|---|
| Type | Description |
$this | |