Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / file_v1.projects.locations.instances.html
blob: c0daa46679ddef70717c27acce7c8692a5457c96 [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">
87 <code><a href="#list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
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:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]101 parent: string, Required. The instance'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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 "name": "A String", # Output only. The resource name of the instance, in the format
109 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 "labels": { # Resource labels to represent user provided metadata.
111 "a_key": "A String",
112 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]113 "createTime": "A String", # Output only. The time when the instance was created.
114 "state": "A String", # Output only. The instance state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]115 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
116 # updates from overwriting each other.
117 "fileShares": [ # File system shares on the instance.
118 # For this version, only a single file share is supported.
119 { # File share configuration for the instance.
120 "capacityGb": "A String", # File share capacity in gigabytes (GB).
121 # Cloud Filestore defines 1 GB as 1024^3 bytes.
122 "name": "A String", # The name of the file share (must be 16 characters or less).
123 },
124 ],
125 "tier": "A String", # The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "networks": [ # VPC networks to which the instance is connected.
127 # For this version, only a single network is supported.
128 { # Network configuration for the instance.
129 "reservedIpRange": "A String", # A /29 CIDR block in one of the
130 # [internal IP address
131 # ranges](https://www.arin.net/knowledge/address_filters.html) that
132 # identifies the range of IP addresses reserved for this instance. For
133 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
134 # with either existing subnets or assigned IP address ranges for other Cloud
135 # Filestore instances in the selected VPC network.
136 "network": "A String", # The name of the Google Compute Engine
137 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
138 # instance is connected.
139 "ipAddresses": [ # Output only. IPv4 addresses in the format
140 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
141 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
142 # 7}:{block 8}.
143 "A String",
144 ],
145 "modes": [ # Internet protocol versions for which the instance has IP addresses
146 # assigned. For this version, only MODE_IPV4 is supported.
147 "A String",
148 ],
149 },
150 ],
151 "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
152 "description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]153 }
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]167 "response": { # The normal response of the operation in case of success. If the original
168 # method returns no data on success, such as `Delete`, the response is
169 # `google.protobuf.Empty`. If the original method is standard
170 # `Get`/`Create`/`Update`, the response should be the resource. For other
171 # methods, the response should have the type `XxxResponse`, where `Xxx`
172 # is the original method name. For example, if the original method name
173 # is `TakeSnapshot()`, the inferred response type is
174 # `TakeSnapshotResponse`.
175 "a_key": "", # Properties of the object. Contains field @type with type URL.
176 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 "metadata": { # Service-specific metadata associated with the operation. It typically
178 # contains progress information and common metadata such as create time.
179 # Some services might not provide such metadata. Any method that returns a
180 # long-running operation should document the metadata type, if any.
181 "a_key": "", # Properties of the object. Contains field @type with type URL.
182 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]183 "done": True or False, # If the value is `false`, it means the operation is still in progress.
184 # If `true`, the operation is completed, and either `error` or `response` is
185 # available.
186 "name": "A String", # The server-assigned name, which is only unique within the same service that
187 # originally returns it. If you use the default HTTP mapping, the
188 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
190 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]191 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
192 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194 # You can find out more about this error model and how to work with it in the
195 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 "message": "A String", # A developer-facing error message, which should be in English. Any
197 # user-facing error message should be localized and sent in the
198 # google.rpc.Status.details field, or localized by the client.
199 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
200 "details": [ # A list of messages that carry the error details. There is a common set of
201 # message types for APIs to use.
202 {
203 "a_key": "", # Properties of the object. Contains field @type with type URL.
204 },
205 ],
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]227 "response": { # The normal response of the operation in case of success. If the original
228 # method returns no data on success, such as `Delete`, the response is
229 # `google.protobuf.Empty`. If the original method is standard
230 # `Get`/`Create`/`Update`, the response should be the resource. For other
231 # methods, the response should have the type `XxxResponse`, where `Xxx`
232 # is the original method name. For example, if the original method name
233 # is `TakeSnapshot()`, the inferred response type is
234 # `TakeSnapshotResponse`.
235 "a_key": "", # Properties of the object. Contains field @type with type URL.
236 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]237 "metadata": { # Service-specific metadata associated with the operation. It typically
238 # contains progress information and common metadata such as create time.
239 # Some services might not provide such metadata. Any method that returns a
240 # long-running operation should document the metadata type, if any.
241 "a_key": "", # Properties of the object. Contains field @type with type URL.
242 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]243 "done": True or False, # If the value is `false`, it means the operation is still in progress.
244 # If `true`, the operation is completed, and either `error` or `response` is
245 # available.
246 "name": "A String", # The server-assigned name, which is only unique within the same service that
247 # originally returns it. If you use the default HTTP mapping, the
248 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
250 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
252 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 # You can find out more about this error model and how to work with it in the
255 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "message": "A String", # A developer-facing error message, which should be in English. Any
257 # user-facing error message should be localized and sent in the
258 # google.rpc.Status.details field, or localized by the client.
259 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
260 "details": [ # A list of messages that carry the error details. There is a common set of
261 # message types for APIs to use.
262 {
263 "a_key": "", # Properties of the object. Contains field @type with type URL.
264 },
265 ],
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]286 "name": "A String", # Output only. The resource name of the instance, in the format
287 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288 "labels": { # Resource labels to represent user provided metadata.
289 "a_key": "A String",
290 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]291 "createTime": "A String", # Output only. The time when the instance was created.
292 "state": "A String", # Output only. The instance state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]293 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
294 # updates from overwriting each other.
295 "fileShares": [ # File system shares on the instance.
296 # For this version, only a single file share is supported.
297 { # File share configuration for the instance.
298 "capacityGb": "A String", # File share capacity in gigabytes (GB).
299 # Cloud Filestore defines 1 GB as 1024^3 bytes.
300 "name": "A String", # The name of the file share (must be 16 characters or less).
301 },
302 ],
303 "tier": "A String", # The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]304 "networks": [ # VPC networks to which the instance is connected.
305 # For this version, only a single network is supported.
306 { # Network configuration for the instance.
307 "reservedIpRange": "A String", # A /29 CIDR block in one of the
308 # [internal IP address
309 # ranges](https://www.arin.net/knowledge/address_filters.html) that
310 # identifies the range of IP addresses reserved for this instance. For
311 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
312 # with either existing subnets or assigned IP address ranges for other Cloud
313 # Filestore instances in the selected VPC network.
314 "network": "A String", # The name of the Google Compute Engine
315 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
316 # instance is connected.
317 "ipAddresses": [ # Output only. IPv4 addresses in the format
318 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
319 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
320 # 7}:{block 8}.
321 "A String",
322 ],
323 "modes": [ # Internet protocol versions for which the instance has IP addresses
324 # assigned. For this version, only MODE_IPV4 is supported.
325 "A String",
326 ],
327 },
328 ],
329 "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
330 "description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]331 }</pre>
332</div>
333
334<div class="method">
335 <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
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
343retrieve instance information for all locations, use "-" for the {location}
344value. (required)
345 orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
346 pageSize: integer, The maximum number of items to return.
347 pageToken: string, The next_page_token value to use if there are additional
348results to retrieve for this list request.
349 x__xgafv: string, V1 error format.
350 Allowed values
351 1 - v1 error format
352 2 - v2 error format
353 filter: string, List filter.
354
355Returns:
356 An object of the form:
357
358 { # ListInstancesResponse is the result of ListInstancesRequest.
359 "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned
360 # if there are no more results in the list.
361 "unreachable": [ # Locations that could not be reached.
362 "A String",
363 ],
364 "instances": [ # A list of instances in the project for the specified location.
365 #
366 # If the {location} value in the request is "-", the response contains a list
367 # of instances from all locations. If any location is unreachable, the
368 # response will only return instances in reachable locations and the
369 # "unreachable" field will be populated with a list of unreachable locations.
370 { # A Cloud Filestore instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]371 "name": "A String", # Output only. The resource name of the instance, in the format
372 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]373 "labels": { # Resource labels to represent user provided metadata.
374 "a_key": "A String",
375 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]376 "createTime": "A String", # Output only. The time when the instance was created.
377 "state": "A String", # Output only. The instance state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]378 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
379 # updates from overwriting each other.
380 "fileShares": [ # File system shares on the instance.
381 # For this version, only a single file share is supported.
382 { # File share configuration for the instance.
383 "capacityGb": "A String", # File share capacity in gigabytes (GB).
384 # Cloud Filestore defines 1 GB as 1024^3 bytes.
385 "name": "A String", # The name of the file share (must be 16 characters or less).
386 },
387 ],
388 "tier": "A String", # The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]389 "networks": [ # VPC networks to which the instance is connected.
390 # For this version, only a single network is supported.
391 { # Network configuration for the instance.
392 "reservedIpRange": "A String", # A /29 CIDR block in one of the
393 # [internal IP address
394 # ranges](https://www.arin.net/knowledge/address_filters.html) that
395 # identifies the range of IP addresses reserved for this instance. For
396 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
397 # with either existing subnets or assigned IP address ranges for other Cloud
398 # Filestore instances in the selected VPC network.
399 "network": "A String", # The name of the Google Compute Engine
400 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
401 # instance is connected.
402 "ipAddresses": [ # Output only. IPv4 addresses in the format
403 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
404 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
405 # 7}:{block 8}.
406 "A String",
407 ],
408 "modes": [ # Internet protocol versions for which the instance has IP addresses
409 # assigned. For this version, only MODE_IPV4 is supported.
410 "A String",
411 ],
412 },
413 ],
414 "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
415 "description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 },
417 ],
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:
430 A request object that you can call 'execute()' on to request the next
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]446 "name": "A String", # Output only. The resource name of the instance, in the format
447 # projects/{project}/locations/{location}/instances/{instance}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 "labels": { # Resource labels to represent user provided metadata.
449 "a_key": "A String",
450 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451 "createTime": "A String", # Output only. The time when the instance was created.
452 "state": "A String", # Output only. The instance state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]453 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
454 # updates from overwriting each other.
455 "fileShares": [ # File system shares on the instance.
456 # For this version, only a single file share is supported.
457 { # File share configuration for the instance.
458 "capacityGb": "A String", # File share capacity in gigabytes (GB).
459 # Cloud Filestore defines 1 GB as 1024^3 bytes.
460 "name": "A String", # The name of the file share (must be 16 characters or less).
461 },
462 ],
463 "tier": "A String", # The service tier of the instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]464 "networks": [ # VPC networks to which the instance is connected.
465 # For this version, only a single network is supported.
466 { # Network configuration for the instance.
467 "reservedIpRange": "A String", # A /29 CIDR block in one of the
468 # [internal IP address
469 # ranges](https://www.arin.net/knowledge/address_filters.html) that
470 # identifies the range of IP addresses reserved for this instance. For
471 # example, 10.0.0.0/29 or 192.168.0.0/29. The range you specify can't overlap
472 # with either existing subnets or assigned IP address ranges for other Cloud
473 # Filestore instances in the selected VPC network.
474 "network": "A String", # The name of the Google Compute Engine
475 # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
476 # instance is connected.
477 "ipAddresses": [ # Output only. IPv4 addresses in the format
478 # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
479 # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
480 # 7}:{block 8}.
481 "A String",
482 ],
483 "modes": [ # Internet protocol versions for which the instance has IP addresses
484 # assigned. For this version, only MODE_IPV4 is supported.
485 "A String",
486 ],
487 },
488 ],
489 "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
490 "description": "A String", # The description of the instance (2048 characters or less).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]491 }
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
497* "description"
498* "file_shares"
499* "labels"
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]510 "response": { # The normal response of the operation in case of success. If the original
511 # method returns no data on success, such as `Delete`, the response is
512 # `google.protobuf.Empty`. If the original method is standard
513 # `Get`/`Create`/`Update`, the response should be the resource. For other
514 # methods, the response should have the type `XxxResponse`, where `Xxx`
515 # is the original method name. For example, if the original method name
516 # is `TakeSnapshot()`, the inferred response type is
517 # `TakeSnapshotResponse`.
518 "a_key": "", # Properties of the object. Contains field @type with type URL.
519 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 "metadata": { # Service-specific metadata associated with the operation. It typically
521 # contains progress information and common metadata such as create time.
522 # Some services might not provide such metadata. Any method that returns a
523 # long-running operation should document the metadata type, if any.
524 "a_key": "", # Properties of the object. Contains field @type with type URL.
525 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]526 "done": True or False, # If the value is `false`, it means the operation is still in progress.
527 # If `true`, the operation is completed, and either `error` or `response` is
528 # available.
529 "name": "A String", # The server-assigned name, which is only unique within the same service that
530 # originally returns it. If you use the default HTTP mapping, the
531 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]532 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
533 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]534 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
535 # three pieces of data: error code, error message, and error details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]536 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]537 # You can find out more about this error model and how to work with it in the
538 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]539 "message": "A String", # A developer-facing error message, which should be in English. Any
540 # user-facing error message should be localized and sent in the
541 # google.rpc.Status.details field, or localized by the client.
542 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
543 "details": [ # A list of messages that carry the error details. There is a common set of
544 # message types for APIs to use.
545 {
546 "a_key": "", # Properties of the object. Contains field @type with type URL.
547 },
548 ],
549 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]550 }</pre>
551</div>
552
553</body></html>