Skip to content

Commit c46c4ec

Browse files
Google APIscopybara-github
authored andcommitted
feat: added annotations
docs: Service Account is a required field fix: Changed field behavior for an existing field `service_account` in message `.google.cloud.config.v1.Deployment` fix: Changed field behavior for an existing field `service_account` in message `.google.cloud.config.v1.Preview` PiperOrigin-RevId: 705212738
1 parent 2f81f77 commit c46c4ec

2 files changed

Lines changed: 36 additions & 14 deletions

File tree

google/cloud/config/v1/config.proto

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ service Config {
135135
option (google.api.method_signature) = "name";
136136
}
137137

138-
// Lists [Resource][google.cloud.config.v1.Resource]s in a given revision.
138+
// Lists [Resources][google.cloud.config.v1.Resource] in a given revision.
139139
rpc ListResources(ListResourcesRequest) returns (ListResourcesResponse) {
140140
option (google.api.http) = {
141141
get: "/v1/{parent=projects/*/locations/*/deployments/*/revisions/*}/resources"
@@ -463,11 +463,11 @@ message Deployment {
463463
optional string artifacts_gcs_bucket = 15
464464
[(google.api.field_behavior) = OPTIONAL];
465465

466-
// Optional. User-specified Service Account (SA) credentials to be used when
466+
// Required. User-specified Service Account (SA) credentials to be used when
467467
// actuating resources.
468468
// Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
469469
optional string service_account = 16 [
470-
(google.api.field_behavior) = OPTIONAL,
470+
(google.api.field_behavior) = REQUIRED,
471471
(google.api.resource_reference) = {
472472
type: "iam.googleapis.com/ServiceAccount"
473473
}
@@ -523,16 +523,17 @@ message Deployment {
523523
// describes the resources and configs to be deployed.
524524
message TerraformBlueprint {
525525
// Location of the source configs.
526+
// Required.
526527
oneof source {
527-
// Required. URI of an object in Google Cloud Storage.
528+
// URI of an object in Google Cloud Storage.
528529
// Format: `gs://{bucket}/{object}`
529530
//
530531
// URI may also specify an object version for zipped objects.
531532
// Format: `gs://{bucket}/{object}#{version}`
532-
string gcs_source = 1 [(google.api.field_behavior) = REQUIRED];
533+
string gcs_source = 1;
533534

534-
// Required. URI of a public Git repo.
535-
GitSource git_source = 2 [(google.api.field_behavior) = REQUIRED];
535+
// URI of a public Git repo.
536+
GitSource git_source = 2;
536537
}
537538

538539
// Input variable values for the Terraform blueprint.
@@ -858,9 +859,9 @@ message OperationMetadata {
858859

859860
// Output only. Identifies whether the user has requested cancellation of the
860861
// operation. Operations that have successfully been cancelled have
861-
// [Operation.error][] value with a
862-
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
863-
// `Code.CANCELLED`.
862+
// [google.longrunning.Operation.error][google.longrunning.Operation.error]
863+
// value with a [google.rpc.Status.code][google.rpc.Status.code] of `1`,
864+
// corresponding to `Code.CANCELLED`.
864865
bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
865866

866867
// Output only. API version used to start the operation.
@@ -1264,7 +1265,7 @@ message ListResourcesRequest {
12641265

12651266
// A response to a 'ListResources' call. Contains a list of Resources.
12661267
message ListResourcesResponse {
1267-
// List of [Resources][]s.
1268+
// List of [Resources][google.cloud.config.v1.Resource].
12681269
repeated Resource resources = 1;
12691270

12701271
// A token to request the next page of resources from the 'ListResources'
@@ -1521,11 +1522,11 @@ message Preview {
15211522
// Optional. Current mode of preview.
15221523
PreviewMode preview_mode = 15 [(google.api.field_behavior) = OPTIONAL];
15231524

1524-
// Optional. User-specified Service Account (SA) credentials to be used when
1525+
// Required. User-specified Service Account (SA) credentials to be used when
15251526
// previewing resources.
15261527
// Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
15271528
string service_account = 7 [
1528-
(google.api.field_behavior) = OPTIONAL,
1529+
(google.api.field_behavior) = REQUIRED,
15291530
(google.api.resource_reference) = {
15301531
type: "iam.googleapis.com/ServiceAccount"
15311532
}
@@ -1592,6 +1593,12 @@ message Preview {
15921593
// Example: "=1.3.10".
15931594
optional string tf_version_constraint = 19
15941595
[(google.api.field_behavior) = OPTIONAL];
1596+
1597+
// Optional. Arbitrary key-value metadata storage e.g. to help client tools
1598+
// identifiy preview during automation. See
1599+
// https://google.aip.dev/148#annotations for details on format and size
1600+
// limitations.
1601+
map<string, string> annotations = 20 [(google.api.field_behavior) = OPTIONAL];
15951602
}
15961603

15971604
// Ephemeral metadata content describing the state of a preview operation.
@@ -1753,7 +1760,7 @@ message ListPreviewsRequest {
17531760

17541761
// A response to a `ListPreviews` call. Contains a list of Previews.
17551762
message ListPreviewsResponse {
1756-
// List of [Previews][]s.
1763+
// List of [Previews][google.cloud.config.v1.Preview].
17571764
repeated Preview previews = 1;
17581765

17591766
// Token to be supplied to the next ListPreviews request via `page_token`
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"methodConfig": [{
3+
"name": [
4+
{ "service": "google.cloud.config.v1.Config"}
5+
],
6+
"timeout": "60s",
7+
"retryPolicy": {
8+
"maxAttempts": 5,
9+
"initialBackoff": "1s",
10+
"maxBackoff": "10s",
11+
"backoffMultiplier": 1.3,
12+
"retryableStatusCodes": ["UNAVAILABLE"]
13+
}
14+
}]
15+
}

0 commit comments

Comments
 (0)