Reference documentation and code samples for the Cloud Monitoring V3 API class Google::Cloud::Monitoring::V3::ListTimeSeriesRequest.
The ListTimeSeries
request.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#aggregation
def aggregation() -> ::Google::Cloud::Monitoring::V3::Aggregation
-
(::Google::Cloud::Monitoring::V3::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.
#aggregation=
def aggregation=(value) -> ::Google::Cloud::Monitoring::V3::Aggregation
-
value (::Google::Cloud::Monitoring::V3::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.
-
(::Google::Cloud::Monitoring::V3::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.
#filter
def filter() -> ::String
-
(::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"
#filter=
def filter=(value) -> ::String
-
value (::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"
-
(::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
def interval() -> ::Google::Cloud::Monitoring::V3::TimeInterval
- (::Google::Cloud::Monitoring::V3::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.
#interval=
def interval=(value) -> ::Google::Cloud::Monitoring::V3::TimeInterval
- value (::Google::Cloud::Monitoring::V3::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.
- (::Google::Cloud::Monitoring::V3::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.
#name
def name() -> ::String
-
(::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]
#name=
def name=(value) -> ::String
-
value (::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]
-
(::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]
#order_by
def order_by() -> ::String
- (::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
#order_by=
def order_by=(value) -> ::String
- value (::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
- (::String) — Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest).
#page_size
def page_size() -> ::Integer
-
(::Integer) — A positive number that is the maximum number of results to return. If
page_size
is empty or more than 100,000 results, the effectivepage_size
is 100,000 results. Ifview
is set toFULL
, this is the maximum number ofPoints
returned. Ifview
is set toHEADERS
, this is the maximum number ofTimeSeries
returned.
#page_size=
def page_size=(value) -> ::Integer
-
value (::Integer) — A positive number that is the maximum number of results to return. If
page_size
is empty or more than 100,000 results, the effectivepage_size
is 100,000 results. Ifview
is set toFULL
, this is the maximum number ofPoints
returned. Ifview
is set toHEADERS
, this is the maximum number ofTimeSeries
returned.
-
(::Integer) — A positive number that is the maximum number of results to return. If
page_size
is empty or more than 100,000 results, the effectivepage_size
is 100,000 results. Ifview
is set toFULL
, this is the maximum number ofPoints
returned. Ifview
is set toHEADERS
, this is the maximum number ofTimeSeries
returned.
#page_token
def page_token() -> ::String
-
(::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.
#page_token=
def page_token=(value) -> ::String
-
value (::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.
-
(::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.
#secondary_aggregation
def secondary_aggregation() -> ::Google::Cloud::Monitoring::V3::Aggregation
-
(::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after
aggregation
is applied. May only be specified ifaggregation
is specified.
#secondary_aggregation=
def secondary_aggregation=(value) -> ::Google::Cloud::Monitoring::V3::Aggregation
-
value (::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after
aggregation
is applied. May only be specified ifaggregation
is specified.
-
(::Google::Cloud::Monitoring::V3::Aggregation) — Apply a second aggregation after
aggregation
is applied. May only be specified ifaggregation
is specified.
#view
def view() -> ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView
- (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.
#view=
def view=(value) -> ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView
- value (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.
- (::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView) — Required. Specifies which information is returned about the time series.