• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<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">
78  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets information about a location.</p>
80<p class="toc_element">
81  <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
82<p class="firstline">Lists information about the supported locations for this service.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</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="get">get(name, x__xgafv=None)</code>
89  <pre>Gets information about a location.
90
91Args:
92  name: string, Resource name for the location. (required)
93  x__xgafv: string, V1 error format.
94    Allowed values
95      1 - v1 error format
96      2 - v2 error format
97
98Returns:
99  An object of the form:
100
101    { # A resource that represents Google Cloud Platform location.
102    "displayName": "A String", # The friendly name for this location, typically a nearby city name.
103        # For example, "Tokyo".
104    "labels": { # Cross-service attributes for the location. For example
105        #
106        #     {"cloud.googleapis.com/region": "us-east1"}
107      "a_key": "A String",
108    },
109    "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
110    "name": "A String", # Resource name for the location, which may vary between implementations.
111        # For example: `"projects/example-project/locations/us-east1"`
112    "metadata": { # Service-specific metadata. For example the available capacity at the given
113        # location.
114      "a_key": "", # Properties of the object. Contains field @type with type URL.
115    },
116  }</pre>
117</div>
118
119<div class="method">
120    <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
121  <pre>Lists information about the supported locations for this service.
122
123Args:
124  name: string, The resource that owns the locations collection, if applicable. (required)
125  pageToken: string, The standard list page token.
126  x__xgafv: string, V1 error format.
127    Allowed values
128      1 - v1 error format
129      2 - v2 error format
130  pageSize: integer, The standard list page size.
131  filter: string, The standard list filter.
132
133Returns:
134  An object of the form:
135
136    { # The response message for Locations.ListLocations.
137    "nextPageToken": "A String", # The standard List next-page token.
138    "locations": [ # A list of locations that matches the specified filter in the request.
139      { # A resource that represents Google Cloud Platform location.
140        "displayName": "A String", # The friendly name for this location, typically a nearby city name.
141            # For example, "Tokyo".
142        "labels": { # Cross-service attributes for the location. For example
143            #
144            #     {"cloud.googleapis.com/region": "us-east1"}
145          "a_key": "A String",
146        },
147        "locationId": "A String", # The canonical id for this location. For example: `"us-east1"`.
148        "name": "A String", # Resource name for the location, which may vary between implementations.
149            # For example: `"projects/example-project/locations/us-east1"`
150        "metadata": { # Service-specific metadata. For example the available capacity at the given
151            # location.
152          "a_key": "", # Properties of the object. Contains field @type with type URL.
153        },
154      },
155    ],
156  }</pre>
157</div>
158
159<div class="method">
160    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
161  <pre>Retrieves the next page of results.
162
163Args:
164  previous_request: The request for the previous page. (required)
165  previous_response: The response from the request for the previous page. (required)
166
167Returns:
168  A request object that you can call 'execute()' on to request the next
169  page. Returns None if there are no more items in the collection.
170    </pre>
171</div>
172
173</body></html>