Skip to content

Commit

Permalink
docs: mark optional fields explicitly in Storage Pool
Browse files Browse the repository at this point in the history 
docs: change comments of the psa_range field to note it is currently not implemented
docs: update comments of ServiceLevel and EncryptionType

PiperOrigin-RevId: 613376353
  • Loading branch information
Google APIs authored and Copybara-Service committed Mar 7, 2024
1 parent 4a86645 commit fe77120
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 36 deletions.
13 changes: 8 additions & 5 deletions google/cloud/netapp/v1/active_directory.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -190,11 +190,14 @@ message ActiveDirectory {
// Required. Password of the Active Directory domain administrator.
string password = 11 [(google.api.field_behavior) = REQUIRED];

// Users to be added to the Built-in Backup Operator active directory group.
repeated string backup_operators = 12;

// Domain users to be given the SeSecurityPrivilege.
repeated string security_operators = 13;
// Optional. Users to be added to the Built-in Backup Operator active
// directory group.
repeated string backup_operators = 12
[(google.api.field_behavior) = OPTIONAL];

// Optional. Domain users to be given the SeSecurityPrivilege.
repeated string security_operators = 13
[(google.api.field_behavior) = OPTIONAL];

// Name of the active directory machine. This optional parameter is used only
// while creating kerberos volume
Expand Down
8 changes: 4 additions & 4 deletions google/cloud/netapp/v1/common.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ option java_package = "com.google.cloud.netapp.v1";
option php_namespace = "Google\\Cloud\\NetApp\\V1";
option ruby_package = "Google::Cloud::NetApp::V1";

// The service levels - Storage Pool, Volumes
// The service level of a storage pool and its volumes.
enum ServiceLevel {
// Unspecified service level.
SERVICE_LEVEL_UNSPECIFIED = 0;
Expand All @@ -35,13 +35,13 @@ enum ServiceLevel {
// Extreme service level.
EXTREME = 2;

// Standard (Software offering)
// Standard service level.
STANDARD = 3;
}

// Defined the current volume encryption key source.
// The volume encryption key source.
enum EncryptionType {
// The source of encryption key is not specified.
// The source of the encryption key is not specified.
ENCRYPTION_TYPE_UNSPECIFIED = 0;

// Google managed encryption key.
Expand Down
58 changes: 33 additions & 25 deletions google/cloud/netapp/v1/storage_pool.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,18 +51,19 @@ message ListStoragePoolsRequest {
}
];

// The maximum number of items to return.
int32 page_size = 2;
// Optional. The maximum number of items to return.
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];

// The next_page_token value to use if there are additional
// Optional. The next_page_token value to use if there are additional
// results to retrieve for this list request.
string page_token = 3;
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];

// Sort results. Supported values are "name", "name desc" or "" (unsorted).
string order_by = 4;
// Optional. Sort results. Supported values are "name", "name desc" or ""
// (unsorted).
string order_by = 4 [(google.api.field_behavior) = OPTIONAL];

// List filter.
string filter = 5;
// Optional. List filter.
string filter = 5 [(google.api.field_behavior) = OPTIONAL];
}

// ListStoragePoolsResponse is the response to a ListStoragePoolsRequest.
Expand Down Expand Up @@ -184,11 +185,11 @@ message StoragePool {
google.protobuf.Timestamp create_time = 8
[(google.api.field_behavior) = OUTPUT_ONLY];

// Description of the storage pool
string description = 9;
// Optional. Description of the storage pool
string description = 9 [(google.api.field_behavior) = OPTIONAL];

// Labels as key value pairs
map<string, string> labels = 10;
// Optional. Labels as key value pairs
map<string, string> labels = 10 [(google.api.field_behavior) = OPTIONAL];

// Required. VPC Network name.
// Format: projects/{project}/global/networks/{network}
Expand All @@ -197,22 +198,29 @@ message StoragePool {
(google.api.resource_reference) = { type: "compute.googleapis.com/Network" }
];

// Specifies the Active Directory to be used for creating a SMB volume.
string active_directory = 12 [(google.api.resource_reference) = {
type: "netapp.googleapis.com/ActiveDirectory"
}];
// Optional. Specifies the Active Directory to be used for creating a SMB
// volume.
string active_directory = 12 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "netapp.googleapis.com/ActiveDirectory"
}
];

// Specifies the KMS config to be used for volume encryption.
string kms_config = 13 [(google.api.resource_reference) = {
type: "netapp.googleapis.com/KmsConfig"
}];
// Optional. Specifies the KMS config to be used for volume encryption.
string kms_config = 13 [
(google.api.field_behavior) = OPTIONAL,
(google.api.resource_reference) = {
type: "netapp.googleapis.com/KmsConfig"
}
];

// Flag indicating if the pool is NFS LDAP enabled or not.
bool ldap_enabled = 14;
// Optional. Flag indicating if the pool is NFS LDAP enabled or not.
bool ldap_enabled = 14 [(google.api.field_behavior) = OPTIONAL];

// Name of the Private Service Access allocated range. If
// not provided, any available range will be chosen.
string psa_range = 15;
// Optional. This field is currently not implemented. Currently values
// provided in this field will be ignored.
string psa_range = 15 [(google.api.field_behavior) = OPTIONAL];

// Output only. Specifies the current pool encryption key source.
EncryptionType encryption_type = 16
Expand Down
4 changes: 2 additions & 2 deletions google/cloud/netapp/v1/volume.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,8 +274,8 @@ message Volume {
// Required. Share name of the volume
string share_name = 5 [(google.api.field_behavior) = REQUIRED];

// Output only. Name of the Private Service Access allocated range. This is
// optional. If not provided, any available range will be chosen.
// Output only. This field is currently not implemented. Currently values
// provided in this field will be ignored.
string psa_range = 6 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. StoragePool name of the volume
Expand Down

0 comments on commit fe77120

Please sign in to comment.