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