ListTimeSeriesRequest
class ListTimeSeriesRequest extends Message
The ListTimeSeries request.
Protobuf type Google\Monitoring\V3\ListTimeSeriesRequest
Methods
No description
The project on which to execute the request. The format is "projects/{project_id_or_number}".
The project on which to execute the request. The format is "projects/{project_id_or_number}".
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.label.instance_name = "my-instance-name"
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.label.instance_name = "my-instance-name"
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.
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.
By default, the raw time series data is returned.
Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
Specifies which information is returned about the time series.
Specifies which information is returned about the time series.
A positive number that is the maximum number of results to return.
A positive number that is the maximum number of results to return.
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.
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.
Details
at line 84
__construct()
at line 96
string
getName()
The project on which to execute the request. The format is "projects/{project_id_or_number}".
Generated from protobuf field string name = 10;
at line 108
setName(string $var)
The project on which to execute the request. The format is "projects/{project_id_or_number}".
Generated from protobuf field string name = 10;
at line 125
string
getFilter()
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.label.instance_name = "my-instance-name"
Generated from protobuf field string filter = 2;
at line 141
setFilter(string $var)
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.label.instance_name = "my-instance-name"
Generated from protobuf field string filter = 2;
at line 155
TimeInterval
getInterval()
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.
Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 4;
at line 168
setInterval(TimeInterval $var)
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.
Generated from protobuf field .google.monitoring.v3.TimeInterval interval = 4;
at line 182
Aggregation
getAggregation()
By default, the raw time series data is returned.
Use this field to combine multiple time series for different views of the data.
Generated from protobuf field .google.monitoring.v3.Aggregation aggregation = 5;
at line 195
setAggregation(Aggregation $var)
By default, the raw time series data is returned.
Use this field to combine multiple time series for different views of the data.
Generated from protobuf field .google.monitoring.v3.Aggregation aggregation = 5;
at line 209
string
getOrderBy()
Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
Generated from protobuf field string order_by = 6;
at line 222
setOrderBy(string $var)
Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.
Generated from protobuf field string order_by = 6;
at line 234
int
getView()
Specifies which information is returned about the time series.
Generated from protobuf field .google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7;
at line 245
setView(int $var)
Specifies which information is returned about the time series.
Generated from protobuf field .google.monitoring.v3.ListTimeSeriesRequest.TimeSeriesView view = 7;
at line 260
int
getPageSize()
A positive number that is the maximum number of results to return.
When view field sets to FULL, it limits the number of Points server
will return; if view field is HEADERS, it limits the number of
TimeSeries server will return.
Generated from protobuf field int32 page_size = 8;
at line 274
setPageSize(int $var)
A positive number that is the maximum number of results to return.
When view field sets to FULL, it limits the number of Points server
will return; if view field is HEADERS, it limits the number of
TimeSeries server will return.
Generated from protobuf field int32 page_size = 8;
at line 288
string
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.
Generated from protobuf field string page_token = 9;
at line 301
setPageToken(string $var)
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.
Generated from protobuf field string page_token = 9;