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
18namespace Google\Service\Apigee\Resource;
19
20use Google\Service\Apigee\GoogleCloudApigeeV1OptimizedStats;
21
22/**
23 * The "optimizedStats" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $apigeeService = new Google\Service\Apigee(...);
27 *   $optimizedStats = $apigeeService->optimizedStats;
28 *  </code>
29 */
30class OrganizationsEnvironmentsOptimizedStats extends \Google\Service\Resource
31{
32  /**
33   * Similar to GetStats except that the response is less verbose.
34   * (optimizedStats.get)
35   *
36   * @param string $name Required. Resource name for which the interactive query
37   * will be executed. Use the following format in your request:
38   * `organizations/{org}/environments/{env}/optimizedStats/{dimensions}`
39   * Dimensions let you view metrics in meaningful groupings, such as `apiproxy`,
40   * `target_host`. The value of `dimensions` should be a comma-separated list as
41   * shown below:
42   * `organizations/{org}/environments/{env}/optimizedStats/apiproxy,request_verb`
43   * @param array $optParams Optional parameters.
44   *
45   * @opt_param string accuracy No longer used by Apigee. Supported for backwards
46   * compatibility.
47   * @opt_param string aggTable Table name used to query custom aggregate tables.
48   * If this parameter is skipped, then Apigee will try to retrieve the data from
49   * fact tables which will be expensive.
50   * @opt_param string filter Filter that enables you to drill-down on specific
51   * dimension values.
52   * @opt_param string limit Maximum number of result items to return. The default
53   * and maximum value that can be returned is 14400.
54   * @opt_param string offset Offset value. Use `offset` with `limit` to enable
55   * pagination of results. For example, to display results 11-20, set limit to
56   * `10` and offset to `10`.
57   * @opt_param bool realtime No longer used by Apigee. Supported for backwards
58   * compatibility.
59   * @opt_param string select Required. Comma-separated list of metrics. For
60   * example: `sum(message_count),sum(error_count)`
61   * @opt_param bool sonar Routes the query to API Monitoring for the last hour.
62   * @opt_param string sort Flag that specifies whether the sort order should be
63   * ascending or descending. Valid values include `DESC` and `ASC`.
64   * @opt_param string sortby Comma-separated list of columns to sort the final
65   * result.
66   * @opt_param string timeRange Required. Time interval for the interactive
67   * query. Time range is specified in GMT as `start~end`. For example:
68   * `04/15/2017 00:00~05/15/2017 23:59`
69   * @opt_param string timeUnit Granularity of metrics returned. Valid values
70   * include: `second`, `minute`, `hour`, `day`, `week`, or `month`.
71   * @opt_param string topk Top number of results to return. For example, to
72   * return the top 5 results, set `topk=5`.
73   * @opt_param bool tsAscending Flag that specifies whether to list timestamps in
74   * ascending (`true`) or descending (`false`) order. Apigee recommends setting
75   * this value to `true` if you are using `sortby` with `sort=DESC`.
76   * @opt_param string tzo Timezone offset value.
77   * @return GoogleCloudApigeeV1OptimizedStats
78   */
79  public function get($name, $optParams = [])
80  {
81    $params = ['name' => $name];
82    $params = array_merge($params, $optParams);
83    return $this->call('get', [$params], GoogleCloudApigeeV1OptimizedStats::class);
84  }
85}
86
87// Adding a class alias for backwards compatibility with the previous class name.
88class_alias(OrganizationsEnvironmentsOptimizedStats::class, 'Google_Service_Apigee_Resource_OrganizationsEnvironmentsOptimizedStats');
89