chore: update generated docs (#1115)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/2ed9ab0e-55b4-4ab2-aede-c95e765f7376/targets
- [x] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/discovery-artifact-manager/commit/0bed8bdae25d545e796cfcdd7a9bfffff11e69da
Source-Link: https://github.com/googleapis/synthtool/commit/c2de32114ec484aa708d32012d1fa8d75232daf5
diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html
index ca40a93..a2c41f3 100644
--- a/docs/dyn/file_v1beta1.projects.locations.backups.html
+++ b/docs/dyn/file_v1beta1.projects.locations.backups.html
@@ -87,7 +87,7 @@
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the details of a specific backup.</p>
<p class="toc_element">
- <code><a href="#list">list(parent, orderBy=None, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, orderBy=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all backups 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>
@@ -111,20 +111,20 @@
The object takes the form of:
{ # A Cloud Filestore backup.
- "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
- "state": "A String", # Output only. The backup state.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
- },
- "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "createTime": "A String", # Output only. The time when the backup was created.
- "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
-}
+ "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
+ "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
+ "createTime": "A String", # Output only. The time when the backup was created.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
+ "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+ "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
+ "state": "A String", # Output only. The backup state.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
+ }
backupId: string, Required. The ID to use for the backup. 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.
@@ -136,22 +136,22 @@
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}`.
"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 originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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.
},
+ "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.
+ },
"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.
+ "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.
},
}</pre>
</div>
@@ -171,22 +171,22 @@
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}`.
"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 originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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.
},
+ "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.
+ },
"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.
+ "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.
},
}</pre>
</div>
@@ -206,32 +206,32 @@
An object of the form:
{ # A Cloud Filestore backup.
- "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
- "state": "A String", # Output only. The backup state.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
- },
- "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "createTime": "A String", # Output only. The time when the backup was created.
- "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
- }</pre>
+ "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
+ "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
+ "createTime": "A String", # Output only. The time when the backup was created.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
+ "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+ "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
+ "state": "A String", # Output only. The backup state.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, orderBy=None, pageToken=None, filter=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, orderBy=None, x__xgafv=None)</code>
<pre>Lists all backups in a project for either a specified location or for all locations.
Args:
parent: string, Required. The project and location for which to retrieve backup information, in the format projects/{project_id}/locations/{location}. In Cloud Filestore, backup locations map to GCP regions, for example **us-west1**. To retrieve backup information for all locations, use "-" for the {location} value. (required)
- orderBy: string, Sort results. Supported values are "name", "name desc" or "" (unsorted).
- pageToken: string, The next_page_token value to use if there are additional results to retrieve for this list request.
- filter: string, List filter.
pageSize: integer, The maximum number of items to return.
+ 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -246,20 +246,20 @@
],
"backups": [ # A list of backups in the project for the specified location. If the {location} value in the request is "-", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the "unreachable" field will be populated with a list of unreachable locations.
{ # A Cloud Filestore backup.
- "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
- "state": "A String", # Output only. The backup state.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
+ "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
+ "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
+ "createTime": "A String", # Output only. The time when the backup was created.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
+ "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+ "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
+ "state": "A String", # Output only. The backup state.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
},
- "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "createTime": "A String", # Output only. The time when the backup was created.
- "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
- },
],
"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>
@@ -289,20 +289,20 @@
The object takes the form of:
{ # A Cloud Filestore backup.
- "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
- "state": "A String", # Output only. The backup state.
- "labels": { # Resource labels to represent user provided metadata.
- "a_key": "A String",
- },
- "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "createTime": "A String", # Output only. The time when the backup was created.
- "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
-}
+ "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
+ "sourceInstance": "A String", # The resource name of the source Cloud Filestore instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}, used to create this backup.
+ "createTime": "A String", # Output only. The time when the backup was created.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "labels": { # Resource labels to represent user provided metadata.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
+ "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
+ "storageBytes": "A String", # Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion.
+ "state": "A String", # Output only. The backup state.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "sourceInstanceTier": "A String", # Output only. The service tier of the source Cloud Filestore instance that this backup is created from.
+ }
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
x__xgafv: string, V1 error format.
@@ -314,22 +314,22 @@
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}`.
"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 originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"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.
},
+ "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.
+ },
"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.
+ "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.
},
}</pre>
</div>