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"> 78 <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"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p> 87<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> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> 90<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"> 95 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists all instances in a project for either a specified location or for all locations.</p> 97<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"> 101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates the settings of a specific instance.</p> 103<p class="toc_element"> 104 <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p> 105<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> 106<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> 109<h3>Method Details</h3> 110<div class="method"> 111 <code class="details" id="close">close()</code> 112 <pre>Close httplib2 connections.</pre> 113</div> 114 115<div class="method"> 116 <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code> 117 <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). 118 119Args: 120 parent: string, Required. The instance'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) 121 body: object, The request body. 122 The object takes the form of: 123 124{ # A Cloud Filestore instance. 125 "createTime": "A String", # Output only. The time when the instance was created. 126 "description": "A String", # The description of the instance (2048 characters or less). 127 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. 128 "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. 129 { # File share configuration for the instance. 130 "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. 131 "name": "A String", # 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). 132 "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share. 133 { # NFS export options specifications. 134 "accessMode": "A String", # 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 "anonGid": "A String", # 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 "anonUid": "A String", # 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. 137 "ipRanges": [ # 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. 138 "A String", 139 ], 140 "squashMode": "A String", # 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 ], 143 "sourceBackup": "A String", # 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. 144 }, 145 ], 146 "kmsKeyName": "A String", # KMS key name used for data encryption. 147 "labels": { # Resource labels to represent user provided metadata. 148 "a_key": "A String", 149 }, 150 "name": "A String", # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. 151 "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported. 152 { # Network configuration for the instance. 153 "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. 154 "ipAddresses": [ # 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}`. 155 "A String", 156 ], 157 "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. 158 "A String", 159 ], 160 "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. 161 "reservedIpRange": "A String", # 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't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. 162 }, 163 ], 164 "satisfiesPzs": True or False, # Output only. Reserved for future use. 165 "state": "A String", # Output only. The instance state. 166 "statusMessage": "A String", # Output only. Additional information about the instance state, if available. 167 "suspensionReasons": [ # Output only. field indicates all the reasons the instance is in "SUSPENDED" state. 168 "A String", 169 ], 170 "tier": "A String", # The service tier of the instance. 171} 172 173 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. 174 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 182 { # This resource represents a long-running operation that is the result of a network API call. 183 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 186 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 187 { 188 "a_key": "", # Properties of the object. Contains field @type with type URL. 189 }, 190 ], 191 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 195 }, 196 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 199 }, 200}</pre> 201</div> 202 203<div class="method"> 204 <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> 205 <pre>Deletes an instance. 206 207Args: 208 name: string, Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}` (required) 209 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.) 210 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 218 { # This resource represents a long-running operation that is the result of a network API call. 219 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 222 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 223 { 224 "a_key": "", # Properties of the object. Contains field @type with type URL. 225 }, 226 ], 227 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 231 }, 232 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 235 }, 236}</pre> 237</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: 244 name: string, Required. The instance resource name, in the format `projects/{project_id}/locations/{location}/instances/{instance_id}`. (required) 245 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. 254 "createTime": "A String", # Output only. The time when the instance was created. 255 "description": "A String", # The description of the instance (2048 characters or less). 256 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. 257 "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. 258 { # File share configuration for the instance. 259 "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. 260 "name": "A String", # 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). 261 "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share. 262 { # NFS export options specifications. 263 "accessMode": "A String", # 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 "anonGid": "A String", # 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 "anonUid": "A String", # 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. 266 "ipRanges": [ # 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. 267 "A String", 268 ], 269 "squashMode": "A String", # 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 ], 272 "sourceBackup": "A String", # 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. 273 }, 274 ], 275 "kmsKeyName": "A String", # KMS key name used for data encryption. 276 "labels": { # Resource labels to represent user provided metadata. 277 "a_key": "A String", 278 }, 279 "name": "A String", # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. 280 "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported. 281 { # Network configuration for the instance. 282 "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. 283 "ipAddresses": [ # 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}`. 284 "A String", 285 ], 286 "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. 287 "A String", 288 ], 289 "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. 290 "reservedIpRange": "A String", # 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't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. 291 }, 292 ], 293 "satisfiesPzs": True or False, # Output only. Reserved for future use. 294 "state": "A String", # Output only. The instance state. 295 "statusMessage": "A String", # Output only. Additional information about the instance state, if available. 296 "suspensionReasons": [ # Output only. field indicates all the reasons the instance is in "SUSPENDED" state. 297 "A String", 298 ], 299 "tier": "A String", # The service tier of the instance. 300}</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 305 <pre>Lists all instances in a project for either a specified location or for all locations. 306 307Args: 308 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 "-" for the `{location}` value. (required) 309 filter: string, List filter. 310 orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted). 311 pageSize: integer, The maximum number of items to return. 312 pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request. 313 x__xgafv: string, V1 error format. 314 Allowed values 315 1 - v1 error format 316 2 - v2 error format 317 318Returns: 319 An object of the form: 320 321 { # ListInstancesResponse is the result of ListInstancesRequest. 322 "instances": [ # A list of instances in the project for the specified location. If the `{location}` value in the request is "-", 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 "unreachable" field will be populated with a list of unreachable locations. 323 { # A Cloud Filestore instance. 324 "createTime": "A String", # Output only. The time when the instance was created. 325 "description": "A String", # The description of the instance (2048 characters or less). 326 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. 327 "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. 328 { # File share configuration for the instance. 329 "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. 330 "name": "A String", # 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). 331 "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share. 332 { # NFS export options specifications. 333 "accessMode": "A String", # 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 "anonGid": "A String", # 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 "anonUid": "A String", # 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. 336 "ipRanges": [ # 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. 337 "A String", 338 ], 339 "squashMode": "A String", # 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 ], 342 "sourceBackup": "A String", # 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. 343 }, 344 ], 345 "kmsKeyName": "A String", # KMS key name used for data encryption. 346 "labels": { # Resource labels to represent user provided metadata. 347 "a_key": "A String", 348 }, 349 "name": "A String", # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. 350 "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported. 351 { # Network configuration for the instance. 352 "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. 353 "ipAddresses": [ # 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}`. 354 "A String", 355 ], 356 "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. 357 "A String", 358 ], 359 "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. 360 "reservedIpRange": "A String", # 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't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. 361 }, 362 ], 363 "satisfiesPzs": True or False, # Output only. Reserved for future use. 364 "state": "A String", # Output only. The instance state. 365 "statusMessage": "A String", # Output only. Additional information about the instance state, if available. 366 "suspensionReasons": [ # Output only. field indicates all the reasons the instance is in "SUSPENDED" state. 367 "A String", 368 ], 369 "tier": "A String", # The service tier of the instance. 370 }, 371 ], 372 "nextPageToken": "A String", # The token you can use to retrieve the next page of results. Not returned if there are no more results in the list. 373 "unreachable": [ # Locations that could not be reached. 374 "A String", 375 ], 376}</pre> 377</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: 388 A request object that you can call 'execute()' on to request the next 389 page. Returns None if there are no more items in the collection. 390 </pre> 391</div> 392 393<div class="method"> 394 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 395 <pre>Updates the settings of a specific instance. 396 397Args: 398 name: string, Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. (required) 399 body: object, The request body. 400 The object takes the form of: 401 402{ # A Cloud Filestore instance. 403 "createTime": "A String", # Output only. The time when the instance was created. 404 "description": "A String", # The description of the instance (2048 characters or less). 405 "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. 406 "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported. 407 { # File share configuration for the instance. 408 "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes. 409 "name": "A String", # 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). 410 "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share. 411 { # NFS export options specifications. 412 "accessMode": "A String", # 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 "anonGid": "A String", # 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 "anonUid": "A String", # 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. 415 "ipRanges": [ # 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. 416 "A String", 417 ], 418 "squashMode": "A String", # 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 ], 421 "sourceBackup": "A String", # 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. 422 }, 423 ], 424 "kmsKeyName": "A String", # KMS key name used for data encryption. 425 "labels": { # Resource labels to represent user provided metadata. 426 "a_key": "A String", 427 }, 428 "name": "A String", # Output only. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. 429 "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported. 430 { # Network configuration for the instance. 431 "connectMode": "A String", # The network connect mode of the Filestore instance. If not provided, the connect mode defaults to DIRECT_PEERING. 432 "ipAddresses": [ # 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}`. 433 "A String", 434 ], 435 "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported. 436 "A String", 437 ], 438 "network": "A String", # The name of the Google Compute Engine [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. 439 "reservedIpRange": "A String", # 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't overlap with either existing subnets or assigned IP address ranges for other Cloud Filestore instances in the selected VPC network. 440 }, 441 ], 442 "satisfiesPzs": True or False, # Output only. Reserved for future use. 443 "state": "A String", # Output only. The instance state. 444 "statusMessage": "A String", # Output only. Additional information about the instance state, if available. 445 "suspensionReasons": [ # Output only. field indicates all the reasons the instance is in "SUSPENDED" state. 446 "A String", 447 ], 448 "tier": "A String", # The service tier of the instance. 449} 450 451 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: * "description" * "file_shares" * "labels" 452 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 460 { # This resource represents a long-running operation that is the result of a network API call. 461 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 464 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 465 { 466 "a_key": "", # Properties of the object. Contains field @type with type URL. 467 }, 468 ], 469 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 473 }, 474 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 477 }, 478}</pre> 479</div> 480 481<div class="method"> 482 <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code> 483 <pre>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). 484 485Args: 486 name: string, Required. The resource name of the instance, in the format `projects/{project_id}/locations/{location_id}/instances/{instance_id}`. (required) 487 body: object, The request body. 488 The object takes the form of: 489 490{ # RestoreInstanceRequest restores an existing instance's file share from a snapshot or backup. 491 "fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to. 492 "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`. 493 "sourceSnapshot": "A String", # The resource name of the snapshot, in the format `projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}`. 494} 495 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. 505 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 508 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 509 { 510 "a_key": "", # Properties of the object. Contains field @type with type URL. 511 }, 512 ], 513 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 517 }, 518 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 521 }, 522}</pre> 523</div> 524 525<div class="method"> 526 <code class="details" id="revert">revert(name, body=None, x__xgafv=None)</code> 527 <pre>Revert an existing instance'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's file share to the specified snapshot. 535 "targetSnapshotId": "A String", # Required. The snapshot resource ID, in the format 'my-snapshot', 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 "done": 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 "error": { # 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 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 550 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 551 { 552 "a_key": "", # Properties of the object. Contains field @type with type URL. 553 }, 554 ], 555 "message": "A String", # 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 "metadata": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 559 }, 560 "name": "A String", # 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 "response": { # 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 "a_key": "", # Properties of the object. Contains field @type with type URL. 563 }, 564}</pre> 565</div> 566 567</body></html>