Debian Codegraph @

docs/dyn/bigtableadmin_v2.projects.instances.clusters.hotTablets.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="bigtableadmin_v2.html">Cloud Bigtable Admin API</a> . <a href="bigtableadmin_v2.projects.html">projects</a> . <a href="bigtableadmin_v2.projects.instances.html">instances</a> . <a href="bigtableadmin_v2.projects.instances.clusters.html">clusters</a> . <a href="bigtableadmin_v2.projects.instances.clusters.hotTablets.html">hotTablets</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#list">list(parent, endTime=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.</p>
83 <p class="toc_element">
84 <code><a href="#list_next">list_next()</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="list">list(parent, endTime=None, pageSize=None, pageToken=None, startTime=None, x__xgafv=None)</code>
94 <pre>Lists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
95
96 Args:
97 parent: string, Required. The cluster name to list hot tablets. Value is in the following form: `projects/{project}/instances/{instance}/clusters/{cluster}`. (required)
98 endTime: string, The end time to list hot tablets.
99 pageSize: integer, Maximum number of results per page. A page_size that is empty or zero lets the server choose the number of items to return. A page_size which is strictly positive will return at most that many items. A negative page_size will cause an error. Following the first request, subsequent paginated calls do not need a page_size field. If a page_size is set in subsequent calls, it must match the page_size given in the first request.
100 pageToken: string, The value of `next_page_token` returned by a previous call.
101 startTime: string, The start time to list hot tablets. The hot tablets in the response will have start times between the requested start time and end time. Start time defaults to Now if it is unset, and end time defaults to Now - 24 hours if it is unset. The start time should be less than the end time, and the maximum allowed time range between start time and end time is 48 hours. Start time and end time should have values between Now and Now - 14 days.
102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
106
107 Returns:
108 An object of the form:
109
110 { # Response message for BigtableInstanceAdmin.ListHotTablets.
111 &quot;hotTablets&quot;: [ # List of hot tablets in the tables of the requested cluster that fall within the requested time range. Hot tablets are ordered by node cpu usage percent. If there are multiple hot tablets that correspond to the same tablet within a 15-minute interval, only the hot tablet with the highest node cpu usage will be included in the response.
112 { # A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.
113 &quot;endKey&quot;: &quot;A String&quot;, # Tablet End Key (inclusive).
114 &quot;endTime&quot;: &quot;A String&quot;, # Output only. The end time of the hot tablet.
115 &quot;name&quot;: &quot;A String&quot;, # The unique name of the hot tablet. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`.
116 &quot;nodeCpuUsagePercent&quot;: 3.14, # Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet).
117 &quot;startKey&quot;: &quot;A String&quot;, # Tablet Start Key (inclusive).
118 &quot;startTime&quot;: &quot;A String&quot;, # Output only. The start time of the hot tablet.
119 &quot;tableName&quot;: &quot;A String&quot;, # Name of the table that contains the tablet. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`.
120 },
121 ],
122 &quot;nextPageToken&quot;: &quot;A String&quot;, # Set if not all hot tablets could be returned in a single response. Pass this value to `page_token` in another request to get the next page of results.
123 }</pre>
124 </div>
125
126 <div class="method">
127 <code class="details" id="list_next">list_next()</code>
128 <pre>Retrieves the next page of results.
129
130 Args:
131 previous_request: The request for the previous page. (required)
132 previous_response: The response from the request for the previous page. (required)
133
134 Returns:
135 A request object that you can call &#x27;execute()&#x27; on to request the next
136 page. Returns None if there are no more items in the collection.
137 </pre>
138 </div>
139
140 </body></html>