docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html
index d5b587e..a61afde 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, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, orderBy=None, filter=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,19 +111,19 @@
The object takes the form of:
{ # A Cloud Filestore backup.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "state": "A String", # Output only. The backup state.
- "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.
- "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.
"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "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",
},
"createTime": "A String", # Output only. The time when the backup was created.
+ "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.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "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.
+ "state": "A String", # Output only. The backup state.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "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.
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
}
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.
@@ -136,23 +136,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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.
- },
- "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.
+ "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.
{
"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.
- "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.
},
- "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.
+ "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}`.
+ "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.
+ },
}</pre>
</div>
@@ -171,23 +171,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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.
- },
- "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.
+ "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.
{
"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.
- "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.
},
- "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.
+ "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}`.
+ "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.
+ },
}</pre>
</div>
@@ -206,32 +206,32 @@
An object of the form:
{ # A Cloud Filestore backup.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "state": "A String", # Output only. The backup state.
- "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.
- "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.
"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "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",
},
"createTime": "A String", # Output only. The time when the backup was created.
+ "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.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "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.
+ "state": "A String", # Output only. The backup state.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "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.
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent, filter=None, orderBy=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, orderBy=None, filter=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)
- filter: string, List filter.
- 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.
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).
+ filter: string, List filter.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -242,26 +242,26 @@
{ # ListBackupsResponse is the result of ListBackupsRequest.
"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",
- ],
"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.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "state": "A String", # Output only. The backup state.
- "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.
- "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.
"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "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",
},
"createTime": "A String", # Output only. The time when the backup was created.
+ "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.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "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.
+ "state": "A String", # Output only. The backup state.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "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.
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
},
],
+ "unreachable": [ # Locations that could not be reached.
+ "A String",
+ ],
}</pre>
</div>
@@ -289,19 +289,19 @@
The object takes the form of:
{ # A Cloud Filestore backup.
- "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
- "sourceFileShare": "A String", # Name of the file share in the source Cloud Filestore instance that the backup is created from.
- "state": "A String", # Output only. The backup state.
- "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.
- "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.
"description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected.
- "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
- "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",
},
"createTime": "A String", # Output only. The time when the backup was created.
+ "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.
+ "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored
+ "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.
+ "state": "A String", # Output only. The backup state.
+ "capacityGb": "A String", # Output only. Capacity of the source file share when the backup was created.
+ "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.
+ "name": "A String", # Output only. The resource name of the backup, in the format projects/{project_id}/locations/{location_id}/backups/{backup_id}.
}
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
@@ -314,23 +314,23 @@
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
- "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.
- },
- "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.
+ "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.
{
"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.
- "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.
},
- "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.
+ "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}`.
+ "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.
+ },
}</pre>
</div>