Skip to content

Commit

Permalink
docs(filestore): Fix various formatting issues and broken links
Browse files Browse the repository at this point in the history 
PiperOrigin-RevId: 387410905
  • Loading branch information
Google APIs authored and Copybara-Service committed Jul 28, 2021
1 parent 26871a2 commit b4967c7
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 71 deletions.
67 changes: 32 additions & 35 deletions google/cloud/filestore/v1/cloud_filestore_service.proto
View file
Expand Up @@ -197,7 +197,7 @@ message NetworkConfig {
}

// The name of the Google Compute Engine
// [VPC network](/compute/docs/networks-and-firewalls#networks) to which the
// [VPC network](https://cloud.google.com/vpc/docs/vpc) to which the
// instance is connected.
string network = 1;

Expand All @@ -207,17 +207,17 @@ message NetworkConfig {

// A /29 CIDR block 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
// ranges](https://www.arin.net/reference/research/statistics/address_filters/)
// 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
// with either existing subnets or assigned IP address ranges for other Cloud
// Filestore instances in the selected VPC network.
string reserved_ip_range = 4;

// 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}.
// IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or
// IPv6 addresses in the format
// `{block1}:{block2}:{block3}:{block4}:{block5}:{block6}:{block7}:{block8}`.
repeated string ip_addresses = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}

Expand All @@ -234,7 +234,7 @@ message FileShareConfig {
// share is created from scratch.
oneof source {
// The resource name of the backup, in the format
// projects/{project_number}/locations/{location_id}/backups/{backup_id},
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`,
// that this file share has been restored from.
string source_backup = 8 [(google.api.resource_reference) = {
type: "file.googleapis.com/Backup"
Expand Down Expand Up @@ -273,8 +273,8 @@ message NfsExportOptions {
}

// List of either an IPv4 addresses in the format
// {octet 1}.{octet 2}.{octet 3}.{octet 4} or CIDR ranges in the format
// {octet 1}.{octet 2}.{octet 3}.{octet 4}/{mask size} which may mount the
// `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format
// `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the
// file share.
// Overlapping IP ranges are not allowed, both within and across
// NfsExportOptions. An error will be returned.
Expand Down Expand Up @@ -367,7 +367,7 @@ message Instance {
}

// Output only. The resource name of the instance, in the format
// projects/{project}/locations/{location}/instances/{instance}.
// `projects/{project}/locations/{location}/instances/{instance}`.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// The description of the instance (2048 characters or less).
Expand Down Expand Up @@ -407,7 +407,7 @@ message Instance {
// CreateInstanceRequest creates an instance.
message CreateInstanceRequest {
// Required. The instance's project and location, in the format
// projects/{project_id}/locations/{location}. In Cloud Filestore,
// `projects/{project_id}/locations/{location}`. In Cloud Filestore,
// locations map to GCP zones, for example **us-west1-b**.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -420,15 +420,14 @@ message CreateInstanceRequest {
// The name must be unique for the specified project and location.
string instance_id = 2 [(google.api.field_behavior) = REQUIRED];

// Required. A [instance resource]
// (/cloud-filestore/reference/rest/v1/projects.locations.instances)
// Required. An [instance resource][google.cloud.filestore.v1.Instance]
Instance instance = 3 [(google.api.field_behavior) = REQUIRED];
}

// GetInstanceRequest gets the state of an instance.
message GetInstanceRequest {
// Required. The instance resource name, in the format
// projects/{project_id}/locations/{location}/instances/{instance_id}.
// `projects/{project_id}/locations/{location}/instances/{instance_id}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down Expand Up @@ -456,7 +455,7 @@ message UpdateInstanceRequest {
// backup.
message RestoreInstanceRequest {
// Required. The resource name of the instance, in the format
// projects/{project_number}/locations/{location_id}/instances/{instance_id}.
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -470,7 +469,7 @@ message RestoreInstanceRequest {

oneof source {
// The resource name of the backup, in the format
// projects/{project_number}/locations/{location_id}/backups/{backup_id}.
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
string source_backup = 3 [(google.api.resource_reference) = {
type: "file.googleapis.com/Backup"
}];
Expand All @@ -480,7 +479,7 @@ message RestoreInstanceRequest {
// DeleteInstanceRequest deletes an instance.
message DeleteInstanceRequest {
// Required. The instance resource name, in the format
// projects/{project_id}/locations/{location}/instances/{instance_id}
// `projects/{project_id}/locations/{location}/instances/{instance_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -492,10 +491,10 @@ message DeleteInstanceRequest {
// ListInstancesRequest lists instances.
message ListInstancesRequest {
// Required. The project and location for which to retrieve instance information,
// in the format projects/{project_id}/locations/{location}. In Cloud
// 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}
// value.
// retrieve instance information for all locations, use "-" for the
// `{location}` value.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -521,8 +520,8 @@ message ListInstancesRequest {
message ListInstancesResponse {
// A list of instances in the project for the specified location.
//
// If the {location} value in the request is "-", the response contains a list
// of instances from all locations. If any location is unreachable, the
// 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.
repeated Instance instances = 1;
Expand Down Expand Up @@ -562,7 +561,7 @@ message Backup {
}

// Output only. The resource name of the backup, in the format
// projects/{project_number}/locations/{location_id}/backups/{backup_id}.
// `projects/{project_number}/locations/{location_id}/backups/{backup_id}`.
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// A description of the backup with 2048 characters or less.
Expand All @@ -586,7 +585,7 @@ message Backup {
int64 storage_bytes = 7 [(google.api.field_behavior) = OUTPUT_ONLY];

// The resource name of the source Cloud Filestore instance, in the format
// projects/{project_number}/locations/{location_id}/instances/{instance_id},
// `projects/{project_number}/locations/{location_id}/instances/{instance_id}`,
// used to create this backup.
string source_instance = 8 [(google.api.resource_reference) = {
type: "file.googleapis.com/Instance"
Expand All @@ -612,7 +611,7 @@ message Backup {
// CreateBackupRequest creates a backup.
message CreateBackupRequest {
// Required. The backup's project and location, in the format
// projects/{project_number}/locations/{location}. In Cloud Filestore,
// `projects/{project_number}/locations/{location}`. In Cloud Filestore,
// backup locations map to GCP regions, for example **us-west1**.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
Expand All @@ -621,8 +620,7 @@ message CreateBackupRequest {
}
];

// Required. A [backup resource]
// (/cloud-filestore/reference/rest/v1/projects.locations.backups)
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
Backup backup = 2 [(google.api.field_behavior) = REQUIRED];

// Required. The ID to use for the backup.
Expand All @@ -638,7 +636,7 @@ message CreateBackupRequest {
// DeleteBackupRequest deletes a backup.
message DeleteBackupRequest {
// Required. The backup resource name, in the format
// projects/{project_number}/locations/{location}/backups/{backup_id}
// `projects/{project_number}/locations/{location}/backups/{backup_id}`
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -649,8 +647,7 @@ message DeleteBackupRequest {

// UpdateBackupRequest updates description and/or labels for a backup.
message UpdateBackupRequest {
// Required. A [backup resource]
// (/cloud-filestore/reference/rest/v1/projects.locations.backups)
// Required. A [backup resource][google.cloud.filestore.v1.Backup]
Backup backup = 1 [(google.api.field_behavior) = REQUIRED];

// Required. Mask of fields to update. At least one path must be supplied in this
Expand All @@ -661,7 +658,7 @@ message UpdateBackupRequest {
// GetBackupRequest gets the state of a backup.
message GetBackupRequest {
// Required. The backup resource name, in the format
// projects/{project_number}/locations/{location}/backups/{backup_id}.
// `projects/{project_number}/locations/{location}/backups/{backup_id}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -673,11 +670,11 @@ message GetBackupRequest {
// ListBackupsRequest lists backups.
message ListBackupsRequest {
// Required. The project and location for which to retrieve backup information,
// in the format projects/{project_number}/locations/{location}.
// in the format `projects/{project_number}/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.
// `{location}` value.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand All @@ -703,8 +700,8 @@ message ListBackupsRequest {
message ListBackupsResponse {
// 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
// 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.
Expand Down

0 comments on commit b4967c7

Please sign in to comment.