Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / file_v1.projects.locations.instances.html
blob: 94f8fd555a984a9624b354dda15314518f44159a [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> . <a href="file_v1.projects.locations.instances.html">instances</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates an instance.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes an instance.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the details of a specific instance.</p>
86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]87 <code><a href="#list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Lists all instances in a project for either a specified location</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]94<p class="firstline">Updates the settings of a specific instance.</p>
95<h3>Method Details</h3>
96<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 <pre>Creates an instance.
99
100Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 parent: string, Required. The instance&#x27;s project and location, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102projects/{project_id}/locations/{location}. In Cloud Filestore,
103locations map to GCP zones, for example **us-west1-b**. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 The object takes the form of:
106
107{ # A Cloud Filestore instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]108 &quot;fileShares&quot;: [ # File system shares on the instance.
109 # For this version, only a single file share is supported.
110 { # File share configuration for the instance.
111 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
112 # Cloud Filestore defines 1 GB as 1024^3 bytes.
113 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
114 },
115 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]116 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
117 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
118 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
120 # For this version, only a single network is supported.
121 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]122 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
123 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
124 # instance is connected.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]125 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
126 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
127 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
128 # 7}:{block 8}.
129 &quot;A String&quot;,
130 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
132 # assigned. For this version, only MODE_IPV4 is supported.
133 &quot;A String&quot;,
134 ],
135 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
136 # [internal IP address
137 # ranges](https://www.arin.net/knowledge/address_filters.html) that
138 # identifies the range of IP addresses reserved for this instance. For
139 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
140 # with either existing subnets or assigned IP address ranges for other Cloud
141 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]144 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
145 &quot;a_key&quot;: &quot;A String&quot;,
146 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]147 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]148 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
149 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
150 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
151 # updates from overwriting each other.
152 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]154
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]155 instanceId: string, Required. The name of the instance to create.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156The name must be unique for the specified project and location.
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # This resource represents a long-running operation that is the result of a
166 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]167 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
168 # contains progress information and common metadata such as create time.
169 # Some services might not provide such metadata. Any method that returns a
170 # long-running operation should document the metadata type, if any.
171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
172 },
173 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
174 # originally returns it. If you use the default HTTP mapping, the
175 # `name` should be a resource name ending with `operations/{unique_id}`.
176 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
177 # If `true`, the operation is completed, and either `error` or `response` is
178 # available.
179 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
180 # different programming environments, including REST APIs and RPC APIs. It is
181 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
182 # three pieces of data: error code, error message, and error details.
183 #
184 # You can find out more about this error model and how to work with it in the
185 # [API Design Guide](https://cloud.google.com/apis/design/errors).
186 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
187 # user-facing error message should be localized and sent in the
188 # google.rpc.Status.details field, or localized by the client.
189 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
190 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
191 # message types for APIs to use.
192 {
193 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
194 },
195 ],
196 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]197 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]198 # method returns no data on success, such as `Delete`, the response is
199 # `google.protobuf.Empty`. If the original method is standard
200 # `Get`/`Create`/`Update`, the response should be the resource. For other
201 # methods, the response should have the type `XxxResponse`, where `Xxx`
202 # is the original method name. For example, if the original method name
203 # is `TakeSnapshot()`, the inferred response type is
204 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]205 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]206 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]207 }</pre>
208</div>
209
210<div class="method">
211 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
212 <pre>Deletes an instance.
213
214Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]215 name: string, Required. The instance resource name, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216projects/{project_id}/locations/{location}/instances/{instance_id} (required)
217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
221
222Returns:
223 An object of the form:
224
225 { # This resource represents a long-running operation that is the result of a
226 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]227 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
228 # contains progress information and common metadata such as create time.
229 # Some services might not provide such metadata. Any method that returns a
230 # long-running operation should document the metadata type, if any.
231 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
232 },
233 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
234 # originally returns it. If you use the default HTTP mapping, the
235 # `name` should be a resource name ending with `operations/{unique_id}`.
236 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
237 # If `true`, the operation is completed, and either `error` or `response` is
238 # available.
239 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
240 # different programming environments, including REST APIs and RPC APIs. It is
241 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
242 # three pieces of data: error code, error message, and error details.
243 #
244 # You can find out more about this error model and how to work with it in the
245 # [API Design Guide](https://cloud.google.com/apis/design/errors).
246 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
247 # user-facing error message should be localized and sent in the
248 # google.rpc.Status.details field, or localized by the client.
249 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
250 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
251 # message types for APIs to use.
252 {
253 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
254 },
255 ],
256 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]257 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]258 # method returns no data on success, such as `Delete`, the response is
259 # `google.protobuf.Empty`. If the original method is standard
260 # `Get`/`Create`/`Update`, the response should be the resource. For other
261 # methods, the response should have the type `XxxResponse`, where `Xxx`
262 # is the original method name. For example, if the original method name
263 # is `TakeSnapshot()`, the inferred response type is
264 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]265 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]266 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 }</pre>
268</div>
269
270<div class="method">
271 <code class="details" id="get">get(name, x__xgafv=None)</code>
272 <pre>Gets the details of a specific instance.
273
274Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]275 name: string, Required. The instance resource name, in the format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
277 x__xgafv: string, V1 error format.
278 Allowed values
279 1 - v1 error format
280 2 - v2 error format
281
282Returns:
283 An object of the form:
284
285 { # A Cloud Filestore instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]286 &quot;fileShares&quot;: [ # File system shares on the instance.
287 # For this version, only a single file share is supported.
288 { # File share configuration for the instance.
289 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
290 # Cloud Filestore defines 1 GB as 1024^3 bytes.
291 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
292 },
293 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]294 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
295 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
296 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]297 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
298 # For this version, only a single network is supported.
299 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]300 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
301 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
302 # instance is connected.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]303 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
304 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
305 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
306 # 7}:{block 8}.
307 &quot;A String&quot;,
308 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]309 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
310 # assigned. For this version, only MODE_IPV4 is supported.
311 &quot;A String&quot;,
312 ],
313 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
314 # [internal IP address
315 # ranges](https://www.arin.net/knowledge/address_filters.html) that
316 # identifies the range of IP addresses reserved for this instance. For
317 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
318 # with either existing subnets or assigned IP address ranges for other Cloud
319 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]320 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]321 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]322 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
323 &quot;a_key&quot;: &quot;A String&quot;,
324 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]325 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]326 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
327 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
328 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
329 # updates from overwriting each other.
330 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]331 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332</div>
333
334<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]335 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]336 <pre>Lists all instances in a project for either a specified location
337or for all locations.
338
339Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]340 parent: string, Required. The project and location for which to retrieve instance information,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]341in the format projects/{project_id}/locations/{location}. In Cloud
342Filestore, locations map to GCP zones, for example **us-west1-b**. To
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]343retrieve instance information for all locations, use &quot;-&quot; for the {location}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]344value. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]345 filter: string, List filter.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]346 orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]347 pageToken: string, The next_page_token value to use if there are additional
348results to retrieve for this list request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]349 pageSize: integer, The maximum number of items to return.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]350 x__xgafv: string, V1 error format.
351 Allowed values
352 1 - v1 error format
353 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]354
355Returns:
356 An object of the form:
357
358 { # ListInstancesResponse is the result of ListInstancesRequest.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]359 &quot;instances&quot;: [ # A list of instances in the project for the specified location.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 #
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]361 # If the {location} value in the request is &quot;-&quot;, the response contains a list
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]362 # of instances from all locations. If any location is unreachable, the
363 # response will only return instances in reachable locations and the
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]364 # &quot;unreachable&quot; field will be populated with a list of unreachable locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 { # A Cloud Filestore instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]366 &quot;fileShares&quot;: [ # File system shares on the instance.
367 # For this version, only a single file share is supported.
368 { # File share configuration for the instance.
369 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
370 # Cloud Filestore defines 1 GB as 1024^3 bytes.
371 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
372 },
373 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]374 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
375 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
376 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]377 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
378 # For this version, only a single network is supported.
379 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]380 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
381 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
382 # instance is connected.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]383 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
384 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
385 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
386 # 7}:{block 8}.
387 &quot;A String&quot;,
388 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]389 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
390 # assigned. For this version, only MODE_IPV4 is supported.
391 &quot;A String&quot;,
392 ],
393 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
394 # [internal IP address
395 # ranges](https://www.arin.net/knowledge/address_filters.html) that
396 # identifies the range of IP addresses reserved for this instance. For
397 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
398 # with either existing subnets or assigned IP address ranges for other Cloud
399 # Filestore instances in the selected VPC network.
400 },
401 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]402 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
403 &quot;a_key&quot;: &quot;A String&quot;,
404 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]405 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]406 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
407 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
408 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
409 # updates from overwriting each other.
410 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]411 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]413 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token you can use to retrieve the next page of results. Not returned
414 # if there are no more results in the list.
415 &quot;unreachable&quot;: [ # Locations that could not be reached.
416 &quot;A String&quot;,
417 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]418 }</pre>
419</div>
420
421<div class="method">
422 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
423 <pre>Retrieves the next page of results.
424
425Args:
426 previous_request: The request for the previous page. (required)
427 previous_response: The response from the request for the previous page. (required)
428
429Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]430 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]431 page. Returns None if there are no more items in the collection.
432 </pre>
433</div>
434
435<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]436 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 <pre>Updates the settings of a specific instance.
438
439Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]440 name: string, Output only. The resource name of the instance, in the format
441projects/{project}/locations/{location}/instances/{instance}. (required)
442 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 The object takes the form of:
444
445{ # A Cloud Filestore instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]446 &quot;fileShares&quot;: [ # File system shares on the instance.
447 # For this version, only a single file share is supported.
448 { # File share configuration for the instance.
449 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB).
450 # Cloud Filestore defines 1 GB as 1024^3 bytes.
451 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 16 characters or less).
452 },
453 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]454 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
455 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format
456 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]457 &quot;networks&quot;: [ # VPC networks to which the instance is connected.
458 # For this version, only a single network is supported.
459 { # Network configuration for the instance.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]460 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine
461 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
462 # instance is connected.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]463 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format
464 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
465 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
466 # 7}:{block 8}.
467 &quot;A String&quot;,
468 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]469 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses
470 # assigned. For this version, only MODE_IPV4 is supported.
471 &quot;A String&quot;,
472 ],
473 &quot;reservedIpRange&quot;: &quot;A String&quot;, # A /29 CIDR block in one of the
474 # [internal IP address
475 # ranges](https://www.arin.net/knowledge/address_filters.html) that
476 # identifies the range of IP addresses reserved for this instance. For
477 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can&#x27;t overlap
478 # with either existing subnets or assigned IP address ranges for other Cloud
479 # Filestore instances in the selected VPC network.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]480 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]481 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]482 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
483 &quot;a_key&quot;: &quot;A String&quot;,
484 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]485 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]486 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
487 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
488 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous
489 # updates from overwriting each other.
490 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]491}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]492
493 updateMask: string, Mask of fields to update. At least one path must be supplied in this
494field. The elements of the repeated paths field may only include these
495fields:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]496
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]497* &quot;description&quot;
498* &quot;file_shares&quot;
499* &quot;labels&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]500 x__xgafv: string, V1 error format.
501 Allowed values
502 1 - v1 error format
503 2 - v2 error format
504
505Returns:
506 An object of the form:
507
508 { # This resource represents a long-running operation that is the result of a
509 # network API call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]510 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
511 # contains progress information and common metadata such as create time.
512 # Some services might not provide such metadata. Any method that returns a
513 # long-running operation should document the metadata type, if any.
514 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
515 },
516 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
517 # originally returns it. If you use the default HTTP mapping, the
518 # `name` should be a resource name ending with `operations/{unique_id}`.
519 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
520 # If `true`, the operation is completed, and either `error` or `response` is
521 # available.
522 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
523 # different programming environments, including REST APIs and RPC APIs. It is
524 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
525 # three pieces of data: error code, error message, and error details.
526 #
527 # You can find out more about this error model and how to work with it in the
528 # [API Design Guide](https://cloud.google.com/apis/design/errors).
529 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
530 # user-facing error message should be localized and sent in the
531 # google.rpc.Status.details field, or localized by the client.
532 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
533 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
534 # message types for APIs to use.
535 {
536 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
537 },
538 ],
539 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]540 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]541 # method returns no data on success, such as `Delete`, the response is
542 # `google.protobuf.Empty`. If the original method is standard
543 # `Get`/`Create`/`Update`, the response should be the resource. For other
544 # methods, the response should have the type `XxxResponse`, where `Xxx`
545 # is the original method name. For example, if the original method name
546 # is `TakeSnapshot()`, the inferred response type is
547 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]548 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]549 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]550 }</pre>
551</div>
552
553</body></html>