Viewing file:  TimeseriesDescriptors.php (4.39 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
/**
* The "timeseriesDescriptors" collection of methods.
* Typical usage is:
* <code>
* $cloudmonitoringService = new Google_Service_CloudMonitoring(...);
* $timeseriesDescriptors = $cloudmonitoringService->timeseriesDescriptors;
* </code>
*/
class Google_Service_CloudMonitoring_Resource_TimeseriesDescriptors extends Google_Service_Resource
{
/**
* List the descriptors of the time series that match the metric and labels
* values and that have data points in the interval. Large responses are
* paginated; use the nextPageToken returned in the response to request
* subsequent pages of results by setting the pageToken query parameter to the
* value of the nextPageToken. (timeseriesDescriptors.listTimeseriesDescriptors)
*
* @param string $project The project ID to which this time series belongs. The
* value can be the numeric project ID or string-based project name.
* @param string $metric Metric names are protocol-free URLs as listed in the
* Supported Metrics page. For example,
* compute.googleapis.com/instance/disk/read_ops_count.
* @param string $youngest End of the time interval (inclusive), which is
* expressed as an RFC 3339 timestamp.
* @param array $optParams Optional parameters.
*
* @opt_param string aggregator The aggregation function that will reduce the
* data points in each window to a single point. This parameter is only valid
* for non-cumulative metrics with a value type of INT64 or DOUBLE.
* @opt_param int count Maximum number of time series descriptors per page. Used
* for pagination. If not specified, count = 100.
* @opt_param string labels A collection of labels for the matching time series,
* which are represented as: - key==value: key equals the value - key=~value:
* key regex matches the value - key!=value: key does not equal the value -
* key!~value: key regex does not match the value For example, to list all of
* the time series descriptors for the region us-central1, you could specify:
* label=cloud.googleapis.com%2Flocation=~us-central1.*
* @opt_param string oldest Start of the time interval (exclusive), which is
* expressed as an RFC 3339 timestamp. If neither oldest nor timespan is
* specified, the default time interval will be (youngest - 4 hours, youngest]
* @opt_param string pageToken The pagination token, which is used to page
* through large result sets. Set this value to the value of the nextPageToken
* to retrieve the next page of results.
* @opt_param string timespan Length of the time interval to query, which is an
* alternative way to declare the interval: (youngest - timespan, youngest]. The
* timespan and oldest parameters should not be used together. Units: - s:
* second - m: minute - h: hour - d: day - w: week Examples: 2s, 3m, 4w.
* Only one unit is allowed, for example: 2w3d is not allowed; you should use
* 17d instead.
*
* If neither oldest nor timespan is specified, the default time interval will
* be (youngest - 4 hours, youngest].
* @opt_param string window The sampling window. At most one data point will be
* returned for each window in the requested time interval. This parameter is
* only valid for non-cumulative metric types. Units: - m: minute - h: hour -
* d: day - w: week Examples: 3m, 4w. Only one unit is allowed, for example:
* 2w3d is not allowed; you should use 17d instead.
* @return Google_Service_CloudMonitoring_ListTimeseriesDescriptorsResponse
*/
public function listTimeseriesDescriptors($project, $metric, $youngest, $optParams = array())
{
$params = array('project' => $project, 'metric' => $metric, 'youngest' => $youngest);
$params = array_merge($params, $optParams);
return $this->call('list', array($params), "Google_Service_CloudMonitoring_ListTimeseriesDescriptorsResponse");
}
}
|