Skip to content

Commit 984bf33

Browse files
Google APIscopybara-github
authored andcommitted
docs: improved comment clarity
PiperOrigin-RevId: 735843146
1 parent 5b8c54e commit 984bf33

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

google/api/cloudquotas/v1beta/quota_adjuster_settings.proto

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ service QuotaAdjusterSettingsManager {
6565

6666
// Request for getting QuotaAdjusterSettings
6767
message GetQuotaAdjusterSettingsRequest {
68-
// Required. Name of the config. Required to be “settings”, as only a single
69-
// setting per container will be supported initially.
68+
// Required. Name of the `quotaAdjusterSettings` configuration. Only a single
69+
// setting per project is supported.
7070
string name = 1 [
7171
(google.api.field_behavior) = REQUIRED,
7272
(google.api.resource_reference) = {
@@ -85,9 +85,9 @@ message UpdateQuotaAdjusterSettingsRequest {
8585
google.protobuf.FieldMask update_mask = 2
8686
[(google.api.field_behavior) = OPTIONAL];
8787

88-
// Optional. If set to true, validate the request, but do not actually update.
89-
// Note that a request being valid does not mean that the request is
90-
// guaranteed to be fulfilled.
88+
// Optional. If set to true, checks the syntax of the request but doesn't
89+
// update the quota adjuster settings value. Note that although a request can
90+
// be valid, that doesn't guarantee that the request will be fulfilled.
9191
bool validate_only = 3 [(google.api.field_behavior) = OPTIONAL];
9292
}
9393

@@ -114,21 +114,22 @@ message QuotaAdjusterSettings {
114114
DISABLED = 3;
115115
}
116116

117-
// Identifier. Name of the config would be of the format:
118-
// projects/12345/locations/global/quotaAdjusterSettings
117+
// Identifier. Name of the configuration, in the following format:
118+
// `projects/PROJECT_NUMBER/locations/global/quotaAdjusterSettings`.
119+
// Replace PROJECT_NUMBER with the project number for your project.
119120
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
120121

121122
// Required. The configured value of the enablement at the given resource.
122123
Enablement enablement = 2 [(google.api.field_behavior) = REQUIRED];
123124

124-
// Output only. The timestamp when the QuotaAdjusterSettings was last updated.
125+
// Output only. The timestamp when the QuotaAdjusterSettings resource was last
126+
// updated.
125127
google.protobuf.Timestamp update_time = 5
126128
[(google.api.field_behavior) = OUTPUT_ONLY];
127129

128-
// Optional. The current etag of the QuotaAdjusterSettings. If an etag is
129-
// provided on update and does not match the current server's etag of the
130-
// QuotaAdjusterSettings, the request will be blocked and an ABORTED error
131-
// will be returned. See https://google.aip.dev/134#etags for more details on
132-
// etags.
130+
// Optional. The current ETag of the QuotaAdjusterSettings. If an ETag is
131+
// provided on update and does not match the current server's ETag in the
132+
// QuotaAdjusterSettings, the request is blocked and returns an ABORTED error.
133+
// See https://google.aip.dev/134#etags for more details on ETags.
133134
string etag = 6 [(google.api.field_behavior) = OPTIONAL];
134135
}

0 commit comments

Comments
 (0)