Stackdriver Monitoring V3 Client - Class ListTimeSeriesRequest (1.11.1)

Reference documentation and code samples for the Stackdriver Monitoring V3 Client class ListTimeSeriesRequest.

The ListTimeSeries request.

Generated from protobuf message google.monitoring.v3.ListTimeSeriesRequest

Namespace

Google \ Cloud \ Monitoring \ V3

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]
↳ filter string

Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"
↳ interval TimeInterval

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
↳ aggregation Aggregation

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels. By default (if no aggregation is explicitly specified), the raw time series data is returned.
↳ secondary_aggregation Aggregation

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.
↳ order_by string

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
↳ view int

Required. Specifies which information is returned about the time series.
↳ page_size int

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
↳ page_token string

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

getName

Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]

Returns
Type Description
string

setName

Required. The project, organization or folder on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

Returns
Type Description
string

setFilter

Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"

Parameter
Name Description
var string
Returns
Type Description
$this

getInterval

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

Returns
Type Description
TimeInterval|null

hasInterval

clearInterval

setInterval

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.

Parameter
Name Description
var TimeInterval
Returns
Type Description
$this

getAggregation

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

Returns
Type Description
Aggregation|null

hasAggregation

clearAggregation

setAggregation

Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series across specified labels.

By default (if no aggregation is explicitly specified), the raw time series data is returned.

Parameter
Name Description
var Aggregation
Returns
Type Description
$this

getSecondaryAggregation

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

Returns
Type Description
Aggregation|null

hasSecondaryAggregation

clearSecondaryAggregation

setSecondaryAggregation

Apply a second aggregation after aggregation is applied. May only be specified if aggregation is specified.

Parameter
Name Description
var Aggregation
Returns
Type Description
$this

getOrderBy

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

Returns
Type Description
string

setOrderBy

Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).

Parameter
Name Description
var string
Returns
Type Description
$this

getView

Required. Specifies which information is returned about the time series.

Returns
Type Description
int

setView

Required. Specifies which information is returned about the time series.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageSize

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

Returns
Type Description
int

setPageSize

A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Returns
Type Description
string

setPageToken

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
name string

Required. The project, organization or folder on which to execute the request. The format is:

projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID] Please see MetricServiceClient::workspaceName() for help formatting this field.
filter string

Required. A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name"
interval TimeInterval

Required. The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
view int

Required. Specifies which information is returned about the time series. For allowed values, use constants defined on ListTimeSeriesRequest\TimeSeriesView
Returns
Type Description
ListTimeSeriesRequest