1<?php 2/* 3 * Copyright 2014 Google Inc. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not 6 * use this file except in compliance with the License. You may obtain a copy of 7 * the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 14 * License for the specific language governing permissions and limitations under 15 * the License. 16 */ 17 18/** 19 * The "stats" collection of methods. 20 * Typical usage is: 21 * <code> 22 * $apigeeService = new Google_Service_Apigee(...); 23 * $stats = $apigeeService->stats; 24 * </code> 25 */ 26class Google_Service_Apigee_Resource_OrganizationsEnvironmentsStats extends Google_Service_Resource 27{ 28 /** 29 * Retrieve metrics grouped by dimensions. The types of metrics you can retrieve 30 * include traffic, message counts, API call latency, response size, and cache 31 * hits and counts. Dimensions let you view metrics in meaningful groups. The 32 * stats api does accept dimensions as path params. The dimensions are optional 33 * in which case the metrics are computed on the entire data for the given 34 * timerange. (stats.get) 35 * 36 * @param string $name Required. The resource name for which the interactive 37 * query will be executed. Must be of the form `organizations/{organization_id}/ 38 * environments/{environment_id/stats/{dimensions}` Dimensions let you view 39 * metrics in meaningful groupings. E.g. apiproxy, target_host. The value of 40 * dimensions should be comma separated list as shown below 41 * `organizations/{org}/environments/{env}/stats/apiproxy,request_verb` 42 * @param array $optParams Optional parameters. 43 * 44 * @opt_param string accuracy Legacy field: not used anymore. This field is 45 * present to support UI calls which still use this parameter. 46 * @opt_param string aggTable If customers want to query custom aggregate 47 * tables, then this parameter can be used to specify the table name. If this 48 * parameter is skipped, then Edge Query will try to retrieve the data from fact 49 * tables which will be expensive. 50 * @opt_param string filter Enables drill-down on specific dimension values 51 * @opt_param string limit This parameter is used to limit the number of result 52 * items. Default and the max value is 14400. 53 * @opt_param string offset Use offset with limit to enable pagination of 54 * results. For example, to display results 11-20, set limit to '10' and offset 55 * to '10'. 56 * @opt_param bool realtime Legacy field: not used anymore. 57 * @opt_param string select The select parameter contains a comma separated list 58 * of metrics. E.g. sum(message_count),sum(error_count) 59 * @opt_param bool sonar This parameter routes the query to api monitoring 60 * service for last hour. 61 * @opt_param string sort This parameter specifies if the sort order should be 62 * ascending or descending Supported values are DESC and ASC. 63 * @opt_param string sortby Comma separated list of columns to sort the final 64 * result. 65 * @opt_param string timeRange Time interval for the interactive query. Time 66 * range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 67 * @opt_param string timeUnit A value of second, minute, hour, day, week, month. 68 * Time Unit specifies the granularity of metrics returned. 69 * @opt_param string topk Take 'top k' results from results, for example, to 70 * return the top 5 results 'topk=5'. 71 * @opt_param bool tsAscending Lists timestamps in ascending order if set to 72 * true. Recommend setting this value to true if you are using sortby with 73 * sort=DESC. 74 * @opt_param string tzo This parameters contains the timezone offset value. 75 * @return Google_Service_Apigee_GoogleCloudApigeeV1Stats 76 */ 77 public function get($name, $optParams = array()) 78 { 79 $params = array('name' => $name); 80 $params = array_merge($params, $optParams); 81 return $this->call('get', array($params), "Google_Service_Apigee_GoogleCloudApigeeV1Stats"); 82 } 83} 84