Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / file_v1.projects.locations.html
blob: 7dafbf9f0431e042a9df3c5a7e0b6675158e3669 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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="file_v1.html">Cloud Filestore API</a> . <a href="file_v1.projects.html">projects</a> . <a href="file_v1.projects.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]78 <code><a href="file_v1.projects.locations.backups.html">backups()</a></code>
79</p>
80<p class="firstline">Returns the backups Resource.</p>
81
82<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83 <code><a href="file_v1.projects.locations.instances.html">instances()</a></code>
84</p>
85<p class="firstline">Returns the instances Resource.</p>
86
87<p class="toc_element">
88 <code><a href="file_v1.projects.locations.operations.html">operations()</a></code>
89</p>
90<p class="firstline">Returns the operations Resource.</p>
91
92<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]93 <code><a href="#close">close()</a></code></p>
94<p class="firstline">Close httplib2 connections.</p>
95<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]96 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
97<p class="firstline">Gets information about a location.</p>
98<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]99 <code><a href="#list">list(name, filter=None, includeUnrevealedLocations=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Lists information about the supported locations for this service.</p>
101<p class="toc_element">
102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
103<p class="firstline">Retrieves the next page of results.</p>
104<h3>Method Details</h3>
105<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]106 <code class="details" id="close">close()</code>
107 <pre>Close httplib2 connections.</pre>
108</div>
109
110<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]111 <code class="details" id="get">get(name, x__xgafv=None)</code>
112 <pre>Gets information about a location.
113
114Args:
115 name: string, Resource name for the location. (required)
116 x__xgafv: string, V1 error format.
117 Allowed values
118 1 - v1 error format
119 2 - v2 error format
120
121Returns:
122 An object of the form:
123
124 { # A resource that represents Google Cloud Platform location.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]125 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
126 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
127 &quot;a_key&quot;: &quot;A String&quot;,
128 },
129 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
130 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
131 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
132 },
133 &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;`
134}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135</div>
136
137<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]138 <code class="details" id="list">list(name, filter=None, includeUnrevealedLocations=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 <pre>Lists information about the supported locations for this service.
140
141Args:
142 name: string, The resource that owns the locations collection, if applicable. (required)
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]143 filter: string, The standard list filter.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]144 includeUnrevealedLocations: boolean, If true, the returned list will include locations which are not yet revealed.
145 pageSize: integer, The standard list page size.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]146 pageToken: string, The standard list page token.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151
152Returns:
153 An object of the form:
154
155 { # The response message for Locations.ListLocations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]156 &quot;locations&quot;: [ # A list of locations that matches the specified filter in the request.
157 { # A resource that represents Google Cloud Platform location.
158 &quot;displayName&quot;: &quot;A String&quot;, # The friendly name for this location, typically a nearby city name. For example, &quot;Tokyo&quot;.
159 &quot;labels&quot;: { # Cross-service attributes for the location. For example {&quot;cloud.googleapis.com/region&quot;: &quot;us-east1&quot;}
160 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]162 &quot;locationId&quot;: &quot;A String&quot;, # The canonical id for this location. For example: `&quot;us-east1&quot;`.
163 &quot;metadata&quot;: { # Service-specific metadata. For example the available capacity at the given location.
164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
166 &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;`
167 },
168 ],
169 &quot;nextPageToken&quot;: &quot;A String&quot;, # The standard List next-page token.
170}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]171</div>
172
173<div class="method">
174 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
175 <pre>Retrieves the next page of results.
176
177Args:
178 previous_request: The request for the previous page. (required)
179 previous_response: The response from the request for the previous page. (required)
180
181Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]183 page. Returns None if there are no more items in the collection.
184 </pre>
185</div>
186
187</body></html>