Skip to content

Commit fe77120

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: mark optional fields explicitly in Storage Pool
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
1 parent 4a86645 commit fe77120

4 files changed

Lines changed: 47 additions & 36 deletions

File tree

‎google/cloud/netapp/v1/active_directory.proto‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -190,11 +190,14 @@ message ActiveDirectory {
190190
// Required. Password of the Active Directory domain administrator.
191191
string password = 11 [(google.api.field_behavior) = REQUIRED];
192192

193-
// Users to be added to the Built-in Backup Operator active directory group.
194-
repeated string backup_operators = 12;
195-
196-
// Domain users to be given the SeSecurityPrivilege.
197-
repeated string security_operators = 13;
193+
// Optional. Users to be added to the Built-in Backup Operator active
194+
// directory group.
195+
repeated string backup_operators = 12
196+
[(google.api.field_behavior) = OPTIONAL];
197+
198+
// Optional. Domain users to be given the SeSecurityPrivilege.
199+
repeated string security_operators = 13
200+
[(google.api.field_behavior) = OPTIONAL];
198201

199202
// Name of the active directory machine. This optional parameter is used only
200203
// while creating kerberos volume

‎google/cloud/netapp/v1/common.proto‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ option java_package = "com.google.cloud.netapp.v1";
2424
option php_namespace = "Google\\Cloud\\NetApp\\V1";
2525
option ruby_package = "Google::Cloud::NetApp::V1";
2626

27-
// The service levels - Storage Pool, Volumes
27+
// The service level of a storage pool and its volumes.
2828
enum ServiceLevel {
2929
// Unspecified service level.
3030
SERVICE_LEVEL_UNSPECIFIED = 0;
@@ -35,13 +35,13 @@ enum ServiceLevel {
3535
// Extreme service level.
3636
EXTREME = 2;
3737

38-
// Standard (Software offering)
38+
// Standard service level.
3939
STANDARD = 3;
4040
}
4141

42-
// Defined the current volume encryption key source.
42+
// The volume encryption key source.
4343
enum EncryptionType {
44-
// The source of encryption key is not specified.
44+
// The source of the encryption key is not specified.
4545
ENCRYPTION_TYPE_UNSPECIFIED = 0;
4646

4747
// Google managed encryption key.

‎google/cloud/netapp/v1/storage_pool.proto‎

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -51,18 +51,19 @@ message ListStoragePoolsRequest {
5151
}
5252
];
5353

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

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

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

64-
// List filter.
65-
string filter = 5;
65+
// Optional. List filter.
66+
string filter = 5 [(google.api.field_behavior) = OPTIONAL];
6667
}
6768

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

187-
// Description of the storage pool
188-
string description = 9;
188+
// Optional. Description of the storage pool
189+
string description = 9 [(google.api.field_behavior) = OPTIONAL];
189190

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

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

200-
// Specifies the Active Directory to be used for creating a SMB volume.
201-
string active_directory = 12 [(google.api.resource_reference) = {
202-
type: "netapp.googleapis.com/ActiveDirectory"
203-
}];
201+
// Optional. Specifies the Active Directory to be used for creating a SMB
202+
// volume.
203+
string active_directory = 12 [
204+
(google.api.field_behavior) = OPTIONAL,
205+
(google.api.resource_reference) = {
206+
type: "netapp.googleapis.com/ActiveDirectory"
207+
}
208+
];
204209

205-
// Specifies the KMS config to be used for volume encryption.
206-
string kms_config = 13 [(google.api.resource_reference) = {
207-
type: "netapp.googleapis.com/KmsConfig"
208-
}];
210+
// Optional. Specifies the KMS config to be used for volume encryption.
211+
string kms_config = 13 [
212+
(google.api.field_behavior) = OPTIONAL,
213+
(google.api.resource_reference) = {
214+
type: "netapp.googleapis.com/KmsConfig"
215+
}
216+
];
209217

210-
// Flag indicating if the pool is NFS LDAP enabled or not.
211-
bool ldap_enabled = 14;
218+
// Optional. Flag indicating if the pool is NFS LDAP enabled or not.
219+
bool ldap_enabled = 14 [(google.api.field_behavior) = OPTIONAL];
212220

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

217225
// Output only. Specifies the current pool encryption key source.
218226
EncryptionType encryption_type = 16

‎google/cloud/netapp/v1/volume.proto‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -274,8 +274,8 @@ message Volume {
274274
// Required. Share name of the volume
275275
string share_name = 5 [(google.api.field_behavior) = REQUIRED];
276276

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

281281
// Required. StoragePool name of the volume

0 commit comments

Comments
 (0)