Google_Service_CloudMonitoring_TimeseriesDescriptors_Resource

The "timeseriesDescriptors" collection of methods.

Defined (1)

The class is defined in the following location(s).

/includes/api-libs/Google/Service/CloudMonitoring.php  
  1. class Google_Service_CloudMonitoring_TimeseriesDescriptors_Resource extends Google_Service_Resource 
  2.  
  3. /** 
  4. * List the descriptors of the time series that match the metric and labels 
  5. * values and that have data points in the interval. Large responses are 
  6. * paginated; use the nextPageToken returned in the response to request 
  7. * subsequent pages of results by setting the pageToken query parameter to the 
  8. * value of the nextPageToken. (timeseriesDescriptors.listTimeseriesDescriptors) 
  9. * @param string $project The project ID to which this time series belongs. The 
  10. * value can be the numeric project ID or string-based project name. 
  11. * @param string $metric Metric names are protocol-free URLs as listed in the 
  12. * Supported Metrics page. For example,  
  13. * compute.googleapis.com/instance/disk/read_ops_count. 
  14. * @param string $youngest End of the time interval (inclusive), which is 
  15. * expressed as an RFC 3339 timestamp. 
  16. * @param array $optParams Optional parameters. 
  17. * @opt_param int count Maximum number of time series descriptors per page. Used 
  18. * for pagination. If not specified, count = 100. 
  19. * @opt_param string timespan Length of the time interval to query, which is an 
  20. * alternative way to declare the interval: (youngest - timespan, youngest]. The 
  21. * timespan and oldest parameters should not be used together. Units: - s: 
  22. * second - m: minute - h: hour - d: day - w: week Examples: 2s, 3m, 4w. 
  23. * Only one unit is allowed, for example: 2w3d is not allowed; you should use 
  24. * 17d instead. 
  25. * If neither oldest nor timespan is specified, the default time interval will 
  26. * be (youngest - 4 hours, youngest]. 
  27. * @opt_param string aggregator The aggregation function that will reduce the 
  28. * data points in each window to a single point. This parameter is only valid 
  29. * for non-cumulative metric types. 
  30. * @opt_param string labels A collection of labels for the matching time series,  
  31. * which are represented as: - key==value: key equals the value - key=~value: 
  32. * key regex matches the value - key!=value: key does not equal the value - 
  33. * key!~value: key regex does not match the value For example, to list all of 
  34. * the time series descriptors for the region us-central1, you could specify: 
  35. * label=cloud.googleapis.com%2Flocation=~us-central1.* 
  36. * @opt_param string pageToken The pagination token, which is used to page 
  37. * through large result sets. Set this value to the value of the nextPageToken 
  38. * to retrieve the next page of results. 
  39. * @opt_param string window The sampling window. At most one data point will be 
  40. * returned for each window in the requested time interval. This parameter is 
  41. * only valid for non-cumulative metric types. Units: - m: minute - h: hour - 
  42. * d: day - w: week Examples: 3m, 4w. Only one unit is allowed, for example: 
  43. * 2w3d is not allowed; you should use 17d instead. 
  44. * @opt_param string oldest Start of the time interval (exclusive), which is 
  45. * expressed as an RFC 3339 timestamp. If neither oldest nor timespan is 
  46. * specified, the default time interval will be (youngest - 4 hours, youngest] 
  47. * @return Google_Service_CloudMonitoring_ListTimeseriesDescriptorsResponse 
  48. */ 
  49. public function listTimeseriesDescriptors($project, $metric, $youngest, $optParams = array()) 
  50. $params = array('project' => $project, 'metric' => $metric, 'youngest' => $youngest); 
  51. $params = array_merge($params, $optParams); 
  52. return $this->call('list', array($params), "Google_Service_CloudMonitoring_ListTimeseriesDescriptorsResponse");