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