docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html
index 28c3592..c12f8dc 100644
--- a/docs/dyn/file_v1beta1.projects.locations.instances.html
+++ b/docs/dyn/file_v1beta1.projects.locations.instances.html
@@ -84,7 +84,7 @@
<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, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all instances in a project for either a specified location</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -98,58 +98,58 @@
<pre>Creates an instance.
Args:
- parent: string, Required. The instance's project and location, in the format
+ 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.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "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.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
},
- "networks": [ # VPC networks to which the instance is connected.
+ "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}.
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "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.
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "ipAddresses": [ # Output only. IPv4 addresses in the format
+ "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",
+ "A String",
],
- "network": "A String", # The name of the Google Compute Engine
+ "network": "A String", # The name of the Google Compute Engine
# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
# instance is connected.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses
+ # assigned. For this version, only MODE_IPV4 is supported.
+ "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.
},
],
- "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.
- "fileShares": [ # File system shares on the instance.
+ "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).
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "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).
},
],
- "tier": "A String", # The service tier of the instance.
- "createTime": "A String", # Output only. The time when the instance was created.
- "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).
+ "tier": "A String", # The service tier of the instance.
+ "description": "A String", # The description of the instance (2048 characters or less).
}
instanceId: string, Required. The ID of the instance to create.
@@ -167,7 +167,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -175,37 +184,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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
+ "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -227,7 +227,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -235,37 +244,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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
+ "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>
@@ -286,56 +286,56 @@
An object of the form:
{ # A Cloud Filestore instance.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "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.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
},
- "networks": [ # VPC networks to which the instance is connected.
+ "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}.
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "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.
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "ipAddresses": [ # Output only. IPv4 addresses in the format
+ "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",
+ "A String",
],
- "network": "A String", # The name of the Google Compute Engine
+ "network": "A String", # The name of the Google Compute Engine
# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
# instance is connected.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses
+ # assigned. For this version, only MODE_IPV4 is supported.
+ "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.
},
],
- "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.
- "fileShares": [ # File system shares on the instance.
+ "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).
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "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).
},
],
- "tier": "A String", # The service tier of the instance.
- "createTime": "A String", # Output only. The time when the instance was created.
- "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).
+ "tier": "A String", # The service tier of the instance.
+ "description": "A String", # The description of the instance (2048 characters or less).
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
<pre>Lists all instances in a project for either a specified location
or for all locations.
@@ -343,81 +343,81 @@
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}
+retrieve instance information for all locations, use "-" for the {location}
value. (required)
- orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
- pageSize: integer, The maximum number of items to return.
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.
+ filter: string, List filter.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
- filter: string, List filter.
Returns:
An object of the form:
{ # ListInstancesResponse is the result of ListInstancesRequest.
- "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.
+ "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
+ # 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.
+ # "unreachable" field will be populated with a list of unreachable locations.
{ # A Cloud Filestore instance.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "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.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
},
- "networks": [ # VPC networks to which the instance is connected.
+ "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}.
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "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.
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "ipAddresses": [ # Output only. IPv4 addresses in the format
+ "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",
+ "A String",
],
- "network": "A String", # The name of the Google Compute Engine
+ "network": "A String", # The name of the Google Compute Engine
# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
# instance is connected.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses
+ # assigned. For this version, only MODE_IPV4 is supported.
+ "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.
},
],
- "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.
- "fileShares": [ # File system shares on the instance.
+ "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).
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "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).
},
],
- "tier": "A String", # The service tier of the instance.
- "createTime": "A String", # Output only. The time when the instance was created.
- "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).
+ "tier": "A String", # The service tier of the instance.
+ "description": "A String", # The description of the instance (2048 characters or less).
},
],
+ "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",
+ ],
}</pre>
</div>
@@ -430,7 +430,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -446,60 +446,60 @@
The object takes the form of:
{ # A Cloud Filestore instance.
- "name": "A String", # Output only. The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "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.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
},
- "networks": [ # VPC networks to which the instance is connected.
+ "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}.
+ "statusMessage": "A String", # Output only. Additional information about the instance state, if available.
+ "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.
- "modes": [ # Internet protocol versions for which the instance has IP addresses
- # assigned. For this version, only MODE_IPV4 is supported.
- "A String",
- ],
- "ipAddresses": [ # Output only. IPv4 addresses in the format
+ "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",
+ "A String",
],
- "network": "A String", # The name of the Google Compute Engine
+ "network": "A String", # The name of the Google Compute Engine
# [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
# instance is connected.
+ "modes": [ # Internet protocol versions for which the instance has IP addresses
+ # assigned. For this version, only MODE_IPV4 is supported.
+ "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.
},
],
- "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.
- "fileShares": [ # File system shares on the instance.
+ "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).
+ "name": "A String", # The name of the file share (must be 16 characters or less).
+ "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).
},
],
- "tier": "A String", # The service tier of the instance.
- "createTime": "A String", # Output only. The time when the instance was created.
- "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).
+ "tier": "A String", # The service tier of the instance.
+ "description": "A String", # The description of the instance (2048 characters or less).
}
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"
+* "description"
+* "file_shares"
+* "labels"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -510,7 +510,16 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "response": { # The normal response of the operation in case of success. If the original
+ "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
@@ -518,37 +527,28 @@
# 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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "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.
- "name": "A String", # The server-assigned name, which is only unique within the same service that
+ "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.
+ "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
+ "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.
- "details": [ # A list of messages that carry the error details. There is a common set of
+ "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.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
},
}</pre>
</div>