blob: b5b5d1e1cf59201661481ff7e47a79cffa922d55 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070081 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Gets information about a location.</p>
83<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070085<p class="firstline">Lists information about the supported locations for this service.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070096 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets information about a location.
98
99Args:
100 name: string, Resource name for the location. (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106Returns:
107 An object of the form:
108
109 { # A resource that represents Google Cloud Platform location.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800110 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
111 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
112 &quot;a_key&quot;: &quot;A String&quot;,
113 },
114 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
115 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
116 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
117 },
118 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
119}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120</div>
121
122<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800123 <code class="details" id="list">list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 <pre>Lists information about the supported locations for this service.
125
126Args:
127 name: string, The resource that owns the locations collection, if applicable. (required)
Anthonios Partheniou10f4b672021-04-13 14:47:53 -0400128 filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like &quot;displayName=tokyo&quot;, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
129 pageSize: integer, The maximum number of results to return. If not set, the service will select a default.
130 pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131 x__xgafv: string, V1 error format.
132 Allowed values
133 1 - v1 error format
134 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700135
136Returns:
137 An object of the form:
138
139 { # The response message for Locations.ListLocations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
141 { # A resource that represents Google Cloud Platform location.
142 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
143 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
144 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700145 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800146 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
147 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
148 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
149 },
150 &quot;name&quot;: &quot;A String&quot;, # Resource name for the location, which may vary between implementations. For example: `&quot;projects/example-project/locations/us-east1&quot;`
151 },
152 ],
153 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
154}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700155</div>
156
157<div class="method">
158 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
159 <pre>Retrieves the next page of results.
160
161Args:
162 previous_request: The request for the previous page. (required)
163 previous_response: The response from the request for the previous page. (required)
164
165Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700166 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700167 page. Returns None if there are no more items in the collection.
168 </pre>
169</div>
170
171</body></html>