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