Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

docs(filestore): Fix various formatting issues and broken links #23

Merged
merged 2 commits into from Aug 10, 2021
Merged

docs(filestore): Fix various formatting issues and broken links #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f5a4829
docs(filestore): Fix various formatting issues and broken links
gcf-owl-bot[bot] Jul 28, 2021
f6c832b
🦉 Updates from OwlBot
gcf-owl-bot[bot] Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 31 additions & 36 deletions ...ud-filestore/src/main/java/com/google/cloud/filestore/v1/CloudFilestoreManagerClient.java
View file
Open in desktop
Expand Up @@ -210,9 +210,9 @@ public final OperationsClient getOperationsClient() {
* }</pre>
*
* @param parent 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 &#42;&#42;us-west1-b&#42;&#42;. To retrieve instance information for
* all locations, use "-" for the {location} value.
* the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map
* to GCP zones, for example &#42;&#42;us-west1-b&#42;&#42;. To retrieve instance information
* for all locations, use "-" for the `{location}` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancesPagedResponse listInstances(LocationName parent) {
Expand Down Expand Up @@ -240,9 +240,9 @@ public final ListInstancesPagedResponse listInstances(LocationName parent) {
* }</pre>
*
* @param parent 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 &#42;&#42;us-west1-b&#42;&#42;. To retrieve instance information for
* all locations, use "-" for the {location} value.
* the format `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map
* to GCP zones, for example &#42;&#42;us-west1-b&#42;&#42;. To retrieve instance information
* for all locations, use "-" for the `{location}` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListInstancesPagedResponse listInstances(String parent) {
Expand Down Expand Up @@ -363,7 +363,7 @@ public final UnaryCallable<ListInstancesRequest, ListInstancesResponse> listInst
* }</pre>
*
* @param name Required. The instance resource name, in the format
* projects/{project_id}/locations/{location}/instances/{instance_id}.
* `projects/{project_id}/locations/{location}/instances/{instance_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Instance getInstance(InstanceName name) {
Expand All @@ -387,7 +387,7 @@ public final Instance getInstance(InstanceName name) {
* }</pre>
*
* @param name Required. The instance resource name, in the format
* projects/{project_id}/locations/{location}/instances/{instance_id}.
* `projects/{project_id}/locations/{location}/instances/{instance_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Instance getInstance(String name) {
Expand Down Expand Up @@ -463,10 +463,9 @@ public final UnaryCallable<GetInstanceRequest, Instance> getInstanceCallable() {
* }</pre>
*
* @param parent 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 &#42;&#42;us-west1-b&#42;&#42;.
* @param instance Required. A [instance resource]
* (/cloud-filestore/reference/rest/v1/projects.locations.instances)
* `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to GCP
* zones, for example &#42;&#42;us-west1-b&#42;&#42;.
* @param instance Required. An [instance resource][google.cloud.filestore.v1.Instance]
* @param instanceId Required. The name of the instance to create. The name must be unique for the
* specified project and location.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -502,10 +501,9 @@ public final OperationFuture<Instance, OperationMetadata> createInstanceAsync(
* }</pre>
*
* @param parent 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 &#42;&#42;us-west1-b&#42;&#42;.
* @param instance Required. A [instance resource]
* (/cloud-filestore/reference/rest/v1/projects.locations.instances)
* `projects/{project_id}/locations/{location}`. In Cloud Filestore, locations map to GCP
* zones, for example &#42;&#42;us-west1-b&#42;&#42;.
* @param instance Required. An [instance resource][google.cloud.filestore.v1.Instance]
* @param instanceId Required. The name of the instance to create. The name must be unique for the
* specified project and location.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down Expand Up @@ -819,7 +817,7 @@ public final UnaryCallable<RestoreInstanceRequest, Operation> restoreInstanceCal
* }</pre>
*
* @param name Required. The instance resource name, in the format
* projects/{project_id}/locations/{location}/instances/{instance_id}
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, OperationMetadata> deleteInstanceAsync(InstanceName name) {
Expand All @@ -843,7 +841,7 @@ public final OperationFuture<Empty, OperationMetadata> deleteInstanceAsync(Insta
* }</pre>
*
* @param name Required. The instance resource name, in the format
* projects/{project_id}/locations/{location}/instances/{instance_id}
* `projects/{project_id}/locations/{location}/instances/{instance_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, OperationMetadata> deleteInstanceAsync(String name) {
Expand Down Expand Up @@ -942,9 +940,9 @@ public final UnaryCallable<DeleteInstanceRequest, Operation> deleteInstanceCalla
* }</pre>
*
* @param parent Required. The project and location for which to retrieve backup information, in
* the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup
* the format `projects/{project_number}/locations/{location}`. In Cloud Filestore, backup
* locations map to GCP regions, for example &#42;&#42;us-west1&#42;&#42;. To retrieve backup
* information for all locations, use "-" for the {location} value.
* information for all locations, use "-" for the `{location}` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBackupsPagedResponse listBackups(LocationName parent) {
Expand Down Expand Up @@ -972,9 +970,9 @@ public final ListBackupsPagedResponse listBackups(LocationName parent) {
* }</pre>
*
* @param parent Required. The project and location for which to retrieve backup information, in
* the format projects/{project_number}/locations/{location}. In Cloud Filestore, backup
* the format `projects/{project_number}/locations/{location}`. In Cloud Filestore, backup
* locations map to GCP regions, for example &#42;&#42;us-west1&#42;&#42;. To retrieve backup
* information for all locations, use "-" for the {location} value.
* information for all locations, use "-" for the `{location}` value.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListBackupsPagedResponse listBackups(String parent) {
Expand Down Expand Up @@ -1095,7 +1093,7 @@ public final UnaryCallable<ListBackupsRequest, ListBackupsResponse> listBackupsC
* }</pre>
*
* @param name Required. The backup resource name, in the format
* projects/{project_number}/locations/{location}/backups/{backup_id}.
* `projects/{project_number}/locations/{location}/backups/{backup_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Backup getBackup(BackupName name) {
Expand All @@ -1119,7 +1117,7 @@ public final Backup getBackup(BackupName name) {
* }</pre>
*
* @param name Required. The backup resource name, in the format
* projects/{project_number}/locations/{location}/backups/{backup_id}.
* `projects/{project_number}/locations/{location}/backups/{backup_id}`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Backup getBackup(String name) {
Expand Down Expand Up @@ -1193,10 +1191,9 @@ public final UnaryCallable<GetBackupRequest, Backup> getBackupCallable() {
* }</pre>
*
* @param parent Required. The backup's project and location, in the format
* projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to
* GCP regions, for example &#42;&#42;us-west1&#42;&#42;.
* @param backup Required. A [backup resource]
* (/cloud-filestore/reference/rest/v1/projects.locations.backups)
* `projects/{project_number}/locations/{location}`. In Cloud Filestore, backup locations map
* to GCP regions, for example &#42;&#42;us-west1&#42;&#42;.
* @param backup Required. A [backup resource][google.cloud.filestore.v1.Backup]
* @param backupId Required. The ID to use for the backup. The ID must be unique within the
* specified project and location.
* <p>This value must start with a lowercase letter followed by up to 62 lowercase letters,
Expand Down Expand Up @@ -1233,10 +1230,9 @@ public final OperationFuture<Backup, OperationMetadata> createBackupAsync(
* }</pre>
*
* @param parent Required. The backup's project and location, in the format
* projects/{project_number}/locations/{location}. In Cloud Filestore, backup locations map to
* GCP regions, for example &#42;&#42;us-west1&#42;&#42;.
* @param backup Required. A [backup resource]
* (/cloud-filestore/reference/rest/v1/projects.locations.backups)
* `projects/{project_number}/locations/{location}`. In Cloud Filestore, backup locations map
* to GCP regions, for example &#42;&#42;us-west1&#42;&#42;.
* @param backup Required. A [backup resource][google.cloud.filestore.v1.Backup]
* @param backupId Required. The ID to use for the backup. The ID must be unique within the
* specified project and location.
* <p>This value must start with a lowercase letter followed by up to 62 lowercase letters,
Expand Down Expand Up @@ -1350,7 +1346,7 @@ public final UnaryCallable<CreateBackupRequest, Operation> createBackupCallable(
* }</pre>
*
* @param name Required. The backup resource name, in the format
* projects/{project_number}/locations/{location}/backups/{backup_id}
* `projects/{project_number}/locations/{location}/backups/{backup_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, OperationMetadata> deleteBackupAsync(BackupName name) {
Expand All @@ -1374,7 +1370,7 @@ public final OperationFuture<Empty, OperationMetadata> deleteBackupAsync(BackupN
* }</pre>
*
* @param name Required. The backup resource name, in the format
* projects/{project_number}/locations/{location}/backups/{backup_id}
* `projects/{project_number}/locations/{location}/backups/{backup_id}`
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, OperationMetadata> deleteBackupAsync(String name) {
Expand Down Expand Up @@ -1471,8 +1467,7 @@ public final UnaryCallable<DeleteBackupRequest, Operation> deleteBackupCallable(
* }
* }</pre>
*
* @param backup Required. A [backup resource]
* (/cloud-filestore/reference/rest/v1/projects.locations.backups)
* @param backup Required. A [backup resource][google.cloud.filestore.v1.Backup]
* @param updateMask Required. Mask of fields to update. At least one path must be supplied in
* this field.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
Expand Down