Class: Google::Cloud::Monitoring::V3::ListTimeSeriesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/monitoring/v3/metric_service.rb

Overview

The ListTimeSeries request.

Defined Under Namespace

Modules: TimeSeriesView

Instance Attribute Summary collapse

Instance Attribute Details

#aggregation ⇒ ::Google::Cloud::Monitoring::V3::Aggregation

Returns 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:

  • (::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.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#filter ⇒ ::String

Returns 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:

  • (::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"



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#interval ⇒ ::Google::Cloud::Monitoring::V3::TimeInterval

Returns 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:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#name ⇒ ::String

Returns 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:

  • (::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]



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#order_by ⇒ ::String

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

Returns:

  • (::String) —

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



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#page_size ⇒ ::Integer

Returns 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:

  • (::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 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.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#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.

Returns:

  • (::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.



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#secondary_aggregation ⇒ ::Google::Cloud::Monitoring::V3::Aggregation

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

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end

#view ⇒ ::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView

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

Returns:



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'proto_docs/google/monitoring/v3/metric_service.rb', line 245

class ListTimeSeriesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Controls which fields are returned by `ListTimeSeries*`.
  module TimeSeriesView
    # Returns the identity of the metric(s), the time series,
    # and the time series data.
    FULL = 0

    # Returns the identity of the metric and the time series resource,
    # but not the time series data.
    HEADERS = 1
  end
end