chore: regens API reference docs (#889)
diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html
index 6e31803..28c3592 100644
--- a/docs/dyn/file_v1beta1.projects.locations.instances.html
+++ b/docs/dyn/file_v1beta1.projects.locations.instances.html
@@ -75,7 +75,7 @@
<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="#create">create(parent, body, instanceId=None, x__xgafv=None)</a></code></p>
+ <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">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
@@ -90,41 +90,41 @@
<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, updateMask=None, x__xgafv=None)</a></code></p>
+ <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>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="create">create(parent, body, instanceId=None, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body=None, instanceId=None, x__xgafv=None)</code>
<pre>Creates an instance.
Args:
- parent: string, 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. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Cloud Filestore instance.
- "description": "A String", # Optional. A description of the instance (2048 characters or less).
+ "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",
},
"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 in one of the
+ "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/29. The range you specify can't overlap
+ # 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}.
@@ -135,8 +135,7 @@
# instance is connected.
},
],
- "state": "A String", # Output only.
- # The instance state.
+ "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.
@@ -148,17 +147,16 @@
},
],
"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.
- "name": "A String", # Output only.
- # The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "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).
}
- instanceId: string, The name of the instance to create.
-The name must be unique for the specified project and location.
+ 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
@@ -193,56 +191,11 @@
# `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). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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.
@@ -262,7 +215,7 @@
<pre>Deletes an instance.
Args:
- name: string, The instance resource name, in the format
+ 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
@@ -298,56 +251,11 @@
# `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). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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.
@@ -367,7 +275,7 @@
<pre>Gets the details of a specific instance.
Args:
- name: string, The instance resource name, in the format
+ 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
@@ -378,26 +286,26 @@
An object of the form:
{ # A Cloud Filestore instance.
- "description": "A String", # Optional. A description of the instance (2048 characters or less).
+ "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",
},
"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 in one of the
+ "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/29. The range you specify can't overlap
+ # 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}.
@@ -408,8 +316,7 @@
# instance is connected.
},
],
- "state": "A String", # Output only.
- # The instance state.
+ "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.
@@ -421,13 +328,9 @@
},
],
"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.
- "name": "A String", # Output only.
- # The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "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).
}</pre>
</div>
@@ -437,7 +340,7 @@
or for all locations.
Args:
- parent: string, The project and location for which to retrieve instance information,
+ 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}
@@ -468,26 +371,26 @@
# 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", # Optional. A description of the instance (2048 characters or less).
+ "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",
},
"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 in one of the
+ "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/29. The range you specify can't overlap
+ # 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}.
@@ -498,8 +401,7 @@
# instance is connected.
},
],
- "state": "A String", # Output only.
- # The instance state.
+ "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.
@@ -511,13 +413,9 @@
},
],
"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.
- "name": "A String", # Output only.
- # The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "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).
},
],
}</pre>
@@ -538,37 +436,36 @@
</div>
<div class="method">
- <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>
+ <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the settings of a specific instance.
Args:
- name: string, Output only.
-The resource name of the instance, in the format
+ 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. (required)
+ body: object, The request body.
The object takes the form of:
{ # A Cloud Filestore instance.
- "description": "A String", # Optional. A description of the instance (2048 characters or less).
+ "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",
},
"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 in one of the
+ "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/29. The range you specify can't overlap
+ # 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}.
@@ -579,8 +476,7 @@
# instance is connected.
},
],
- "state": "A String", # Output only.
- # The instance state.
+ "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.
@@ -592,19 +488,18 @@
},
],
"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.
- "name": "A String", # Output only.
- # The resource name of the instance, in the format
- # projects/{project_id}/locations/{location_id}/instances/{instance_id}.
+ "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).
}
- updateMask: string, Mask of fields to update. At least one path must be supplied in this
+ 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"
+
+* "description"
+* "file_shares"
+* "labels"
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -639,56 +534,11 @@
# `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). The error model is designed to be:
+ # used by [gRPC](https://github.com/grpc). Each `Status` message contains
+ # three pieces of data: error code, error message, and error details.
#
- # - Simple to use and understand for most users
- # - Flexible enough to meet unexpected needs
- #
- # # Overview
- #
- # The `Status` message contains three pieces of data: error code, error
- # message, and error details. The error code should be an enum value of
- # google.rpc.Code, but it may accept additional error codes if needed. The
- # error message should be a developer-facing English message that helps
- # developers *understand* and *resolve* the error. If a localized user-facing
- # error message is needed, put the localized message in the error details or
- # localize it in the client. The optional error details may contain arbitrary
- # information about the error. There is a predefined set of error detail types
- # in the package `google.rpc` that can be used for common error conditions.
- #
- # # Language mapping
- #
- # The `Status` message is the logical representation of the error model, but it
- # is not necessarily the actual wire format. When the `Status` message is
- # exposed in different client libraries and different wire protocols, it can be
- # mapped differently. For example, it will likely be mapped to some exceptions
- # in Java, but more likely mapped to some error codes in C.
- #
- # # Other uses
- #
- # The error model and the `Status` message can be used in a variety of
- # environments, either with or without APIs, to provide a
- # consistent developer experience across different environments.
- #
- # Example uses of this error model include:
- #
- # - Partial errors. If a service needs to return partial errors to the client,
- # it may embed the `Status` in the normal response to indicate the partial
- # errors.
- #
- # - Workflow errors. A typical workflow has multiple steps. Each step may
- # have a `Status` message for error reporting.
- #
- # - Batch operations. If a client uses batch request and batch response, the
- # `Status` message should be used directly inside batch response, one for
- # each error sub-response.
- #
- # - Asynchronous operations. If an API call embeds asynchronous operation
- # results in its response, the status of those operations should be
- # represented directly using the `Status` message.
- #
- # - Logging. If some API errors are stored in logs, the message `Status` could
- # be used directly after any stripping needed for security/privacy reasons.
+ # 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.