blob: 6a0c1bd2938e6e4b8bcf37c66c5f66c15d6b28e0 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
yoshi-code-bota36e3b12021-07-27 00:20:26 -070078 <code><a href="file_v1beta1.projects.locations.instances.snapshots.html">snapshots()</a></code>
79</p>
80<p class="firstline">Returns the snapshots Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070086 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070087<p class="firstline">Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070088<p class="toc_element">
yoshi-code-bot2da5ed12021-09-07 00:20:27 -070089 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070090<p class="firstline">Deletes an instance.</p>
91<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
93<p class="firstline">Gets the details of a specific instance.</p>
94<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -080095 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096<p class="firstline">Lists all instances in a project for either a specified location or for all locations.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700102<p class="firstline">Updates the settings of a specific instance.</p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103<p class="toc_element">
104 <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800105<p class="firstline">Restores an existing instance's file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).</p>
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700106<p class="toc_element">
107 <code><a href="#revert">revert(name, body=None, x__xgafv=None)</a></code></p>
108<p class="firstline">Revert an existing instance's file system to a specified snapshot.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<h3>Method Details</h3>
110<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700111 <code class="details" id="close">close()</code>
112 <pre>Close httplib2 connections.</pre>
113</div>
114
115<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700116 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700117 <pre>Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700118
119Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700120 parent: string, Required. The instance&#x27;s project and location, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700121 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700122 The object takes the form of:
123
124{ # A Cloud Filestore instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800125 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
126 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
127 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800128 &quot;fileShares&quot;: [ # File system shares on the instance. For this version, only a single file share is supported.
129 { # File share configuration for the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800130 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700131 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800132 &quot;nfsExportOptions&quot;: [ # Nfs Export Options. There is a limit of 10 export options per file share.
133 { # NFS export options specifications.
134 &quot;accessMode&quot;: &quot;A String&quot;, # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
135 &quot;anonGid&quot;: &quot;A String&quot;, # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
136 &quot;anonUid&quot;: &quot;A String&quot;, # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700137 &quot;ipRanges&quot;: [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800138 &quot;A String&quot;,
139 ],
140 &quot;squashMode&quot;: &quot;A String&quot;, # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
141 },
142 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700143 &quot;sourceBackup&quot;: &quot;A String&quot;, # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800144 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800145 ],
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700146 &quot;kmsKeyName&quot;: &quot;A String&quot;, # KMS key name used for data encryption.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800147 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
148 &quot;a_key&quot;: &quot;A String&quot;,
149 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700150 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800151 &quot;networks&quot;: [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
152 { # Network configuration for the instance.
yoshi-code-bot07708072021-07-20 00:20:24 -0700153 &quot;connectMode&quot;: &quot;A String&quot;, # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700154 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800155 &quot;A String&quot;,
156 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800157 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
158 &quot;A String&quot;,
159 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700160 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
161 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can&#x27;t overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800162 },
163 ],
yoshi-code-botcec43932021-04-24 08:36:03 -0700164 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800165 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
166 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700167 &quot;suspensionReasons&quot;: [ # Output only. field indicates all the reasons the instance is in &quot;SUSPENDED&quot; state.
168 &quot;A String&quot;,
169 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800170 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800171}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700172
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700173 instanceId: string, Required. The ID of the instance to create. The ID must be unique within the specified project and location. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700174 x__xgafv: string, V1 error format.
175 Allowed values
176 1 - v1 error format
177 2 - v2 error format
178
179Returns:
180 An object of the form:
181
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800183 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
184 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
185 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
186 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
187 {
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 ],
191 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
192 },
193 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
194 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
195 },
196 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
197 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
198 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
199 },
200}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700201</div>
202
203<div class="method">
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700204 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700205 <pre>Deletes an instance.
206
207Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700208 name: string, Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}` (required)
yoshi-code-bot2da5ed12021-09-07 00:20:27 -0700209 force: boolean, If set to true, any snapshots of the instance will also be deleted. (Otherwise, the request will only work if the instance has no snapshots.)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700218 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800219 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
220 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
221 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
222 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
223 {
224 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
225 },
226 ],
227 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
228 },
229 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
230 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
231 },
232 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
233 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
234 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
235 },
236}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700237</div>
238
239<div class="method">
240 <code class="details" id="get">get(name, x__xgafv=None)</code>
241 <pre>Gets the details of a specific instance.
242
243Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700244 name: string, Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700245 x__xgafv: string, V1 error format.
246 Allowed values
247 1 - v1 error format
248 2 - v2 error format
249
250Returns:
251 An object of the form:
252
253 { # A Cloud Filestore instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800254 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
255 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
256 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
257 &quot;fileShares&quot;: [ # File system shares on the instance. For this version, only a single file share is supported.
258 { # File share configuration for the instance.
259 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700260 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800261 &quot;nfsExportOptions&quot;: [ # Nfs Export Options. There is a limit of 10 export options per file share.
262 { # NFS export options specifications.
263 &quot;accessMode&quot;: &quot;A String&quot;, # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
264 &quot;anonGid&quot;: &quot;A String&quot;, # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
265 &quot;anonUid&quot;: &quot;A String&quot;, # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700266 &quot;ipRanges&quot;: [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 &quot;A String&quot;,
268 ],
269 &quot;squashMode&quot;: &quot;A String&quot;, # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
270 },
271 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700272 &quot;sourceBackup&quot;: &quot;A String&quot;, # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800273 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800274 ],
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700275 &quot;kmsKeyName&quot;: &quot;A String&quot;, # KMS key name used for data encryption.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800276 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
277 &quot;a_key&quot;: &quot;A String&quot;,
278 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700279 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800280 &quot;networks&quot;: [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
281 { # Network configuration for the instance.
yoshi-code-bot07708072021-07-20 00:20:24 -0700282 &quot;connectMode&quot;: &quot;A String&quot;, # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700283 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800284 &quot;A String&quot;,
285 ],
286 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
287 &quot;A String&quot;,
288 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700289 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
290 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can&#x27;t overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800291 },
292 ],
yoshi-code-botcec43932021-04-24 08:36:03 -0700293 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800294 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
295 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700296 &quot;suspensionReasons&quot;: [ # Output only. field indicates all the reasons the instance is in &quot;SUSPENDED&quot; state.
297 &quot;A String&quot;,
298 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800299 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
300}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700301</div>
302
303<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800304 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700305 <pre>Lists all instances in a project for either a specified location or for all locations.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700306
307Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700308 parent: string, Required. The project and location for which to retrieve instance information, in the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to GCP zones, for example **us-west1-b**. To retrieve instance information for all locations, use &quot;-&quot; for the `{location}` value. (required)
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700309 filter: string, List filter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800310 orderBy: string, Sort results. Supported values are &quot;name&quot;, &quot;name desc&quot; or &quot;&quot; (unsorted).
311 pageSize: integer, The maximum number of items to return.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800312 pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 x__xgafv: string, V1 error format.
314 Allowed values
315 1 - v1 error format
316 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700317
318Returns:
319 An object of the form:
320
321 { # ListInstancesResponse is the result of ListInstancesRequest.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700322 &quot;instances&quot;: [ # A list of instances in the project for the specified location. If the `{location}` value in the request is &quot;-&quot;, the response contains a list of instances from all locations. If any location is unreachable, the response will only return instances in reachable locations and the &quot;unreachable&quot; field will be populated with a list of unreachable locations.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800323 { # A Cloud Filestore instance.
324 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
325 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
326 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
327 &quot;fileShares&quot;: [ # File system shares on the instance. For this version, only a single file share is supported.
328 { # File share configuration for the instance.
329 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700330 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800331 &quot;nfsExportOptions&quot;: [ # Nfs Export Options. There is a limit of 10 export options per file share.
332 { # NFS export options specifications.
333 &quot;accessMode&quot;: &quot;A String&quot;, # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
334 &quot;anonGid&quot;: &quot;A String&quot;, # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
335 &quot;anonUid&quot;: &quot;A String&quot;, # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700336 &quot;ipRanges&quot;: [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800337 &quot;A String&quot;,
338 ],
339 &quot;squashMode&quot;: &quot;A String&quot;, # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
340 },
341 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700342 &quot;sourceBackup&quot;: &quot;A String&quot;, # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700343 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800344 ],
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700345 &quot;kmsKeyName&quot;: &quot;A String&quot;, # KMS key name used for data encryption.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800346 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
347 &quot;a_key&quot;: &quot;A String&quot;,
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800348 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700349 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800350 &quot;networks&quot;: [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
351 { # Network configuration for the instance.
yoshi-code-bot07708072021-07-20 00:20:24 -0700352 &quot;connectMode&quot;: &quot;A String&quot;, # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700353 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800354 &quot;A String&quot;,
355 ],
356 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
357 &quot;A String&quot;,
358 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700359 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
360 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can&#x27;t overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800361 },
362 ],
yoshi-code-botcec43932021-04-24 08:36:03 -0700363 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800364 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
365 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700366 &quot;suspensionReasons&quot;: [ # Output only. field indicates all the reasons the instance is in &quot;SUSPENDED&quot; state.
367 &quot;A String&quot;,
368 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
370 },
371 ],
372 &quot;nextPageToken&quot;: &quot;A String&quot;, # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
373 &quot;unreachable&quot;: [ # Locations that could not be reached.
374 &quot;A String&quot;,
375 ],
376}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700388 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700394 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700395 <pre>Updates the settings of a specific instance.
396
397Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700398 name: string, Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700399 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700400 The object takes the form of:
401
402{ # A Cloud Filestore instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800403 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the instance was created.
404 &quot;description&quot;: &quot;A String&quot;, # The description of the instance (2048 characters or less).
405 &quot;etag&quot;: &quot;A String&quot;, # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800406 &quot;fileShares&quot;: [ # File system shares on the instance. For this version, only a single file share is supported.
407 { # File share configuration for the instance.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800408 &quot;capacityGb&quot;: &quot;A String&quot;, # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
yoshi-code-bot3e4b5db2021-08-10 00:22:29 -0700409 &quot;name&quot;: &quot;A String&quot;, # The name of the file share (must be 32 characters or less for Enterprise and High Scale SSD tiers and 16 characters or less for all other tiers).
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800410 &quot;nfsExportOptions&quot;: [ # Nfs Export Options. There is a limit of 10 export options per file share.
411 { # NFS export options specifications.
412 &quot;accessMode&quot;: &quot;A String&quot;, # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
413 &quot;anonGid&quot;: &quot;A String&quot;, # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
414 &quot;anonUid&quot;: &quot;A String&quot;, # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700415 &quot;ipRanges&quot;: [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800416 &quot;A String&quot;,
417 ],
418 &quot;squashMode&quot;: &quot;A String&quot;, # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
419 },
420 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700421 &quot;sourceBackup&quot;: &quot;A String&quot;, # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800422 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800423 ],
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700424 &quot;kmsKeyName&quot;: &quot;A String&quot;, # KMS key name used for data encryption.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800425 &quot;labels&quot;: { # Resource labels to represent user provided metadata.
426 &quot;a_key&quot;: &quot;A String&quot;,
427 },
yoshi-code-bot96afc042021-08-24 00:22:31 -0700428 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800429 &quot;networks&quot;: [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
430 { # Network configuration for the instance.
yoshi-code-bot07708072021-07-20 00:20:24 -0700431 &quot;connectMode&quot;: &quot;A String&quot;, # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700432 &quot;ipAddresses&quot;: [ # Output only. IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or IPv6 addresses in the format `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800433 &quot;A String&quot;,
434 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800435 &quot;modes&quot;: [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
436 &quot;A String&quot;,
437 ],
yoshi-code-bot96afc042021-08-24 00:22:31 -0700438 &quot;network&quot;: &quot;A String&quot;, # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected.
439 &quot;reservedIpRange&quot;: &quot;A String&quot;, # Optional, reserved_ip_range can have one of the following two types of values. * CIDR range value when using DIRECT_PEERING connect mode. * [Allocated IP address range](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-internal-ip-address) when using PRIVATE_SERVICE_ACCESS connect mode. When the name of an allocated IP address range is specified, it must be one of the ranges associated with the private service access connection. When specified as a direct CIDR value, it must be a /29 CIDR block for Basic tier or a /24 CIDR block for High Scale or Enterprise tier in one of the [internal IP address ranges](https://www.arin.net/reference/research/statistics/address_filters/) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/24. The range you specify can&#x27;t overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800440 },
441 ],
yoshi-code-botcec43932021-04-24 08:36:03 -0700442 &quot;satisfiesPzs&quot;: True or False, # Output only. Reserved for future use.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800443 &quot;state&quot;: &quot;A String&quot;, # Output only. The instance state.
444 &quot;statusMessage&quot;: &quot;A String&quot;, # Output only. Additional information about the instance state, if available.
yoshi-code-bot8bb904c2021-08-31 00:28:27 -0700445 &quot;suspensionReasons&quot;: [ # Output only. field indicates all the reasons the instance is in &quot;SUSPENDED&quot; state.
446 &quot;A String&quot;,
447 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800448 &quot;tier&quot;: &quot;A String&quot;, # The service tier of the instance.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800449}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700450
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700451 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * &quot;description&quot; * &quot;file_shares&quot; * &quot;labels&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700452 x__xgafv: string, V1 error format.
453 Allowed values
454 1 - v1 error format
455 2 - v2 error format
456
457Returns:
458 An object of the form:
459
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700460 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
462 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
463 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
464 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
465 {
466 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
467 },
468 ],
469 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
470 },
471 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
472 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
473 },
474 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
475 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
476 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
477 },
478}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700479</div>
480
481<div class="method">
482 <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800483 <pre>Restores an existing instance&#x27;s file share from a backup. The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700484
485Args:
yoshi-code-bot96afc042021-08-24 00:22:31 -0700486 name: string, Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700487 body: object, The request body.
488 The object takes the form of:
489
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700490{ # RestoreInstanceRequest restores an existing instance&#x27;s file share from a snapshot or backup.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800491 &quot;fileShare&quot;: &quot;A String&quot;, # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to.
yoshi-code-bot96afc042021-08-24 00:22:31 -0700492 &quot;sourceBackup&quot;: &quot;A String&quot;, # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`.
493 &quot;sourceSnapshot&quot;: &quot;A String&quot;, # The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800494}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700495
496 x__xgafv: string, V1 error format.
497 Allowed values
498 1 - v1 error format
499 2 - v2 error format
500
501Returns:
502 An object of the form:
503
504 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800505 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
506 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
507 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
508 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
509 {
510 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
511 },
512 ],
513 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
514 },
515 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
516 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
517 },
518 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
519 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
520 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
521 },
522}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700523</div>
524
yoshi-code-bot12d387c2021-10-26 00:24:32 -0700525<div class="method">
526 <code class="details" id="revert">revert(name, body=None, x__xgafv=None)</code>
527 <pre>Revert an existing instance&#x27;s file system to a specified snapshot.
528
529Args:
530 name: string, Required. projects/{project_id}/locations/{location_id}/instances/{instance_id}. The resource name of the instance, in the format (required)
531 body: object, The request body.
532 The object takes the form of:
533
534{ # RevertInstanceRequest reverts the given instance&#x27;s file share to the specified snapshot.
535 &quot;targetSnapshotId&quot;: &quot;A String&quot;, # Required. The snapshot resource ID, in the format &#x27;my-snapshot&#x27;, where the specified ID is the {snapshot_id} of the fully qualified name like projects/{project_id}/locations/{location_id}/instances/{instance_id}/snapshots/{snapshot_id}
536}
537
538 x__xgafv: string, V1 error format.
539 Allowed values
540 1 - v1 error format
541 2 - v2 error format
542
543Returns:
544 An object of the form:
545
546 { # This resource represents a long-running operation that is the result of a network API call.
547 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
548 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
549 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
550 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
551 {
552 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
553 },
554 ],
555 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
556 },
557 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
558 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
559 },
560 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
561 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
562 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
563 },
564}</pre>
565</div>
566
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700567</body></html>