docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html
index a2391fd..7f17b15 100644
--- a/docs/dyn/file_v1beta1.projects.locations.instances.html
+++ b/docs/dyn/file_v1beta1.projects.locations.instances.html
@@ -75,6 +75,9 @@
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#create">create(parent, body=None, instanceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an instance.</p>
<p class="toc_element">
@@ -84,108 +87,76 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a specific instance.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
-<p class="firstline">Lists all instances in a project for either a specified location</p>
+ <code><a href="#list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Lists all instances in a project for either a specified location or for all locations.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the settings of a specific instance.</p>
+<p class="toc_element">
+ <code><a href="#restore">restore(name, body=None, x__xgafv=None)</a></code></p>
+<p class="firstline">Restores an existing instance's file share from a snapshot or backup.</p>
<h3>Method Details</h3>
<div class="method">
+ <code class="details" id="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
<pre>Creates an instance.
Args:
- 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)
+ 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)
body: object, The request body.
The object takes the form of:
{ # A Cloud Filestore instance.
- "tier": "A String", # The service tier of the instance.
- "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
- "description": "A String", # The description of the instance (2048 characters or less).
- "createTime": "A String", # Output only. The time when the instance was created.
- "fileShares": [ # File system shares on the instance.
- # For this version, only a single file share is supported.
- { # File share configuration for the instance.
- "nfsExportOptions": [ # Nfs Export Options.
- # There is a limit of 10 export options per file share.
- { # NFS export options specifications.
- "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.
- "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.
- "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.
- "ipRanges": [ # List of either an IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
- "A String",
- ],
- "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.
- },
- ],
- "capacityGb": "A String", # File share capacity in gigabytes (GB).
- # Cloud Filestore defines 1 GB as 1024^3 bytes.
- "name": "A String", # The name of the file share (must be 16 characters or less).
- },
- ],
- "state": "A String", # Output only. The instance state.
- "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
- # updates from overwriting each other.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "networks": [ # VPC networks to which the instance is connected.
- # For this version, only a single network is supported.
- { # Network configuration for the instance.
- "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
- # [internal IP address
- # ranges](https://www.arin.net/knowledge/address_filters.html) that
- # identifies the range of IP addresses reserved for this instance. For
- # example, 10.0.0.0/29 or 192.168.0.0/23. 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.
- "ipAddresses": [ # Output only. IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
- # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
- # 7}:{block 8}.
- "A String",
- ],
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "network": "A String", # The name of the Google Compute Engine
- # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected.
- },
- ],
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "description": "A String", # The description of the instance (2048 characters or less).
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
+ { # File share configuration for the instance.
+ "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
+ "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.
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
+ { # NFS export options specifications.
+ "ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
+ "A String",
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ },
+ ],
},
- }
+ ],
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "state": "A String", # Output only. The instance state.
+ "name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
+ "createTime": "A String", # Output only. The time when the instance was created.
+ "tier": "A String", # The service tier of the instance.
+ "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
+ { # Network configuration for the instance.
+ "ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
+ "A String",
+ ],
+ "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. 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.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
+ "A String",
+ ],
+ "network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
+ },
+ ],
+}
- 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.
+ 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.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -194,48 +165,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
+ "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}`.
}</pre>
</div>
@@ -244,8 +191,7 @@
<pre>Deletes an instance.
Args:
- name: string, Required. The instance resource name, in the format
-projects/{project_id}/locations/{location}/instances/{instance_id} (required)
+ name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -254,48 +200,24 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "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`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
+ "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}`.
}</pre>
</div>
@@ -304,8 +226,7 @@
<pre>Gets the details of a specific instance.
Args:
- name: string, Required. The instance resource name, in the format
-projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
+ name: string, Required. The instance resource name, in the format projects/{project_id}/locations/{location}/instances/{instance_id}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -315,97 +236,57 @@
An object of the form:
{ # A Cloud Filestore instance.
- "tier": "A String", # The service tier of the instance.
- "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
- "description": "A String", # The description of the instance (2048 characters or less).
- "createTime": "A String", # Output only. The time when the instance was created.
- "fileShares": [ # File system shares on the instance.
- # For this version, only a single file share is supported.
- { # File share configuration for the instance.
- "nfsExportOptions": [ # Nfs Export Options.
- # There is a limit of 10 export options per file share.
- { # NFS export options specifications.
- "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.
- "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.
- "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.
- "ipRanges": [ # List of either an IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
- "A String",
- ],
- "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.
- },
- ],
- "capacityGb": "A String", # File share capacity in gigabytes (GB).
- # Cloud Filestore defines 1 GB as 1024^3 bytes.
- "name": "A String", # The name of the file share (must be 16 characters or less).
- },
- ],
- "state": "A String", # Output only. The instance state.
- "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
- # updates from overwriting each other.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "networks": [ # VPC networks to which the instance is connected.
- # For this version, only a single network is supported.
- { # Network configuration for the instance.
- "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
- # [internal IP address
- # ranges](https://www.arin.net/knowledge/address_filters.html) that
- # identifies the range of IP addresses reserved for this instance. For
- # example, 10.0.0.0/29 or 192.168.0.0/23. 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.
- "ipAddresses": [ # Output only. IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
- # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
- # 7}:{block 8}.
- "A String",
- ],
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "network": "A String", # The name of the Google Compute Engine
- # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected.
- },
- ],
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "description": "A String", # The description of the instance (2048 characters or less).
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
+ { # File share configuration for the instance.
+ "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
+ "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.
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
+ { # NFS export options specifications.
+ "ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
+ "A String",
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ },
+ ],
},
- }</pre>
+ ],
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "state": "A String", # Output only. The instance state.
+ "name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
+ "createTime": "A String", # Output only. The time when the instance was created.
+ "tier": "A String", # The service tier of the instance.
+ "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
+ { # Network configuration for the instance.
+ "ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
+ "A String",
+ ],
+ "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. 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.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
+ "A String",
+ ],
+ "network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
+ },
+ ],
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
- <pre>Lists all instances in a project for either a specified location
-or for all locations.
+ <code class="details" id="list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
+ <pre>Lists all instances in a project for either a specified location or for all locations.
Args:
- 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)
- pageToken: string, The next_page_token value to use if there are additional
-results to retrieve for this list request.
+ 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)
filter: string, List filter.
+ pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
pageSize: integer, The maximum number of items to return.
x__xgafv: string, V1 error format.
@@ -417,94 +298,54 @@
An object of the form:
{ # ListInstancesResponse is the result of ListInstancesRequest.
+ "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.
+ { # A Cloud Filestore instance.
+ "description": "A String", # The description of the instance (2048 characters or less).
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
+ { # File share configuration for the instance.
+ "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
+ "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.
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
+ { # NFS export options specifications.
+ "ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
+ "A String",
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ },
+ ],
+ },
+ ],
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "state": "A String", # Output only. The instance state.
+ "name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
+ "createTime": "A String", # Output only. The time when the instance was created.
+ "tier": "A String", # The service tier of the instance.
+ "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
+ { # Network configuration for the instance.
+ "ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
+ "A String",
+ ],
+ "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. 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.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
+ "A String",
+ ],
+ "network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
+ },
+ ],
+ },
+ ],
+ "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.
"unreachable": [ # Locations that could not be reached.
"A String",
],
- "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.
- { # A Cloud Filestore instance.
- "tier": "A String", # The service tier of the instance.
- "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
- "description": "A String", # The description of the instance (2048 characters or less).
- "createTime": "A String", # Output only. The time when the instance was created.
- "fileShares": [ # File system shares on the instance.
- # For this version, only a single file share is supported.
- { # File share configuration for the instance.
- "nfsExportOptions": [ # Nfs Export Options.
- # There is a limit of 10 export options per file share.
- { # NFS export options specifications.
- "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.
- "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.
- "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.
- "ipRanges": [ # List of either an IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
- "A String",
- ],
- "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.
- },
- ],
- "capacityGb": "A String", # File share capacity in gigabytes (GB).
- # Cloud Filestore defines 1 GB as 1024^3 bytes.
- "name": "A String", # The name of the file share (must be 16 characters or less).
- },
- ],
- "state": "A String", # Output only. The instance state.
- "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
- # updates from overwriting each other.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "networks": [ # VPC networks to which the instance is connected.
- # For this version, only a single network is supported.
- { # Network configuration for the instance.
- "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
- # [internal IP address
- # ranges](https://www.arin.net/knowledge/address_filters.html) that
- # identifies the range of IP addresses reserved for this instance. For
- # example, 10.0.0.0/29 or 192.168.0.0/23. 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.
- "ipAddresses": [ # Output only. IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
- # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
- # 7}:{block 8}.
- "A String",
- ],
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "network": "A String", # The name of the Google Compute Engine
- # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected.
- },
- ],
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
- },
- },
- ],
- "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.
}</pre>
</div>
@@ -527,95 +368,54 @@
<pre>Updates the settings of a specific instance.
Args:
- name: string, Output only. The resource name of the instance, in the format
-projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
+ name: string, Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
body: object, The request body.
The object takes the form of:
{ # A Cloud Filestore instance.
- "tier": "A String", # The service tier of the instance.
- "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
- "description": "A String", # The description of the instance (2048 characters or less).
- "createTime": "A String", # Output only. The time when the instance was created.
- "fileShares": [ # File system shares on the instance.
- # For this version, only a single file share is supported.
- { # File share configuration for the instance.
- "nfsExportOptions": [ # Nfs Export Options.
- # There is a limit of 10 export options per file share.
- { # NFS export options specifications.
- "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.
- "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.
- "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.
- "ipRanges": [ # List of either an IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
- "A String",
- ],
- "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.
- },
- ],
- "capacityGb": "A String", # File share capacity in gigabytes (GB).
- # Cloud Filestore defines 1 GB as 1024^3 bytes.
- "name": "A String", # The name of the file share (must be 16 characters or less).
- },
- ],
- "state": "A String", # Output only. The instance state.
- "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous
- # updates from overwriting each other.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "networks": [ # VPC networks to which the instance is connected.
- # For this version, only a single network is supported.
- { # Network configuration for the instance.
- "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the
- # [internal IP address
- # ranges](https://www.arin.net/knowledge/address_filters.html) that
- # identifies the range of IP addresses reserved for this instance. For
- # example, 10.0.0.0/29 or 192.168.0.0/23. 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.
- "ipAddresses": [ # Output only. IPv4 addresses in the format
- # {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format
- # {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block
- # 7}:{block 8}.
- "A String",
- ],
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "network": "A String", # The name of the Google Compute Engine
- # [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
- # instance is connected.
- },
- ],
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "description": "A String", # The description of the instance (2048 characters or less).
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "fileShares": [ # File system shares on the instance. For this version, only a single file share is supported.
+ { # File share configuration for the instance.
+ "capacityGb": "A String", # File share capacity in gigabytes (GB). Cloud Filestore defines 1 GB as 1024^3 bytes.
+ "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.
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "nfsExportOptions": [ # Nfs Export Options. There is a limit of 10 export options per file share.
+ { # NFS export options specifications.
+ "ipRanges": [ # List of either an IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format {octet 1}.{octet 2}.{octet 3}.{octet 4}/{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.
+ "A String",
+ ],
+ "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.
+ "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.
+ "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.
+ "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.
+ },
+ ],
},
- }
+ ],
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "state": "A String", # Output only. The instance state.
+ "name": "A String", # Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "etag": "A String", # Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
+ "createTime": "A String", # Output only. The time when the instance was created.
+ "tier": "A String", # The service tier of the instance.
+ "networks": [ # VPC networks to which the instance is connected. For this version, only a single network is supported.
+ { # Network configuration for the instance.
+ "ipAddresses": [ # Output only. IPv4 addresses in the format {octet 1}.{octet 2}.{octet 3}.{octet 4} or IPv6 addresses in the format {block 1}:{block 2}:{block 3}:{block 4}:{block 5}:{block 6}:{block 7}:{block 8}.
+ "A String",
+ ],
+ "reservedIpRange": "A String", # A /29 CIDR block for Basic or a /23 CIDR block for High Scale in one of the [internal IP address ranges](https://www.arin.net/knowledge/address_filters.html) that identifies the range of IP addresses reserved for this instance. For example, 10.0.0.0/29 or 192.168.0.0/23. 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.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses assigned. For this version, only MODE_IPV4 is supported.
+ "A String",
+ ],
+ "network": "A String", # The name of the Google Compute Engine [VPC network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected.
+ },
+ ],
+}
- 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"
+ 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"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -624,48 +424,68 @@
Returns:
An object of the form:
- { # This resource represents a long-running operation that is the result of a
- # network API call.
- "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}`.
- "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
- # 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).
- "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
- # message types for APIs to use.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "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`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
- "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.
+ "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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "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`.
+ "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}`.
+ }</pre>
+</div>
+
+<div class="method">
+ <code class="details" id="restore">restore(name, body=None, x__xgafv=None)</code>
+ <pre>Restores an existing instance's file share from a snapshot or backup.
+
+Args:
+ name: string, Required. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # RestoreInstanceRequest restores an existing instances's file share from a snapshot or backup.
+ "fileShare": "A String", # Required. Name of the file share in the Cloud Filestore instance that the snapshot is being restored to.
+ "sourceSnapshot": "A String", # The resource name of the snapshot, in the format projects/{project_id}/locations/{location_id}/snapshots/{snapshot_id}.
+ "sourceBackup": "A String", # The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
+ }
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "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.
+ "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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "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.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "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.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ },
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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}`.
}</pre>
</div>