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\BigtableAdmin\Resource;
19
20use Google\Service\BigtableAdmin\ListHotTabletsResponse;
21
22/**
23 * The "hotTablets" collection of methods.
24 * Typical usage is:
25 *  <code>
26 *   $bigtableadminService = new Google\Service\BigtableAdmin(...);
27 *   $hotTablets = $bigtableadminService->hotTablets;
28 *  </code>
29 */
30class ProjectsInstancesClustersHotTablets extends \Google\Service\Resource
31{
32  /**
33   * Lists hot tablets in a cluster, within the time range provided. Hot tablets
34   * are ordered based on CPU usage.
35   * (hotTablets.listProjectsInstancesClustersHotTablets)
36   *
37   * @param string $parent Required. The cluster name to list hot tablets. Value
38   * is in the following form:
39   * `projects/{project}/instances/{instance}/clusters/{cluster}`.
40   * @param array $optParams Optional parameters.
41   *
42   * @opt_param string endTime The end time to list hot tablets.
43   * @opt_param int pageSize Maximum number of results per page. A page_size that
44   * is empty or zero lets the server choose the number of items to return. A
45   * page_size which is strictly positive will return at most that many items. A
46   * negative page_size will cause an error. Following the first request,
47   * subsequent paginated calls do not need a page_size field. If a page_size is
48   * set in subsequent calls, it must match the page_size given in the first
49   * request.
50   * @opt_param string pageToken The value of `next_page_token` returned by a
51   * previous call.
52   * @opt_param string startTime The start time to list hot tablets. The hot
53   * tablets in the response will have start times between the requested start
54   * time and end time. Start time defaults to Now if it is unset, and end time
55   * defaults to Now - 24 hours if it is unset. The start time should be less than
56   * the end time, and the maximum allowed time range between start time and end
57   * time is 48 hours. Start time and end time should have values between Now and
58   * Now - 14 days.
59   * @return ListHotTabletsResponse
60   */
61  public function listProjectsInstancesClustersHotTablets($parent, $optParams = [])
62  {
63    $params = ['parent' => $parent];
64    $params = array_merge($params, $optParams);
65    return $this->call('list', [$params], ListHotTabletsResponse::class);
66  }
67}
68
69// Adding a class alias for backwards compatibility with the previous class name.
70class_alias(ProjectsInstancesClustersHotTablets::class, 'Google_Service_BigtableAdmin_Resource_ProjectsInstancesClustersHotTablets');
71