Skip to content

Commit 6deeeed

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
feat: [deploy] added support for new custom target type and deploy policy platform logs (#5561)
* feat: added support for new custom target type and deploy policy platform logs docs: small Cloud Deploy API documentation updates PiperOrigin-RevId: 653323174 Source-Link: googleapis/googleapis@9293133 Source-Link: googleapis/googleapis-gen@655395d Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWRlcGxveS8uT3dsQm90LnlhbWwiLCJoIjoiNjU1Mzk1ZDhkMDVlMjhlMjEwYzBkZTk3YTlmNWE3OGNmNDRhMDk3OCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 2c4325f commit 6deeeed

27 files changed

Lines changed: 2132 additions & 158 deletions

‎packages/google-cloud-deploy/protos/google/cloud/deploy/v1/cloud_deploy.proto‎

Lines changed: 59 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -986,9 +986,8 @@ message GetDeliveryPipelineRequest {
986986

987987
// The request object for `CreateDeliveryPipeline`.
988988
message CreateDeliveryPipelineRequest {
989-
// Required. The parent collection in which the `DeliveryPipeline` should be
990-
// created. Format should be
991-
// `projects/{project_id}/locations/{location_name}`.
989+
// Required. The parent collection in which the `DeliveryPipeline` must be
990+
// created. The format is `projects/{project_id}/locations/{location_name}`.
992991
string parent = 1 [
993992
(google.api.field_behavior) = REQUIRED,
994993
(google.api.resource_reference) = {
@@ -1025,11 +1024,11 @@ message CreateDeliveryPipelineRequest {
10251024

10261025
// The request object for `UpdateDeliveryPipeline`.
10271026
message UpdateDeliveryPipelineRequest {
1028-
// Required. Field mask is used to specify the fields to be overwritten in the
1029-
// `DeliveryPipeline` resource by the update.
1030-
// The fields specified in the update_mask are relative to the resource, not
1031-
// the full request. A field will be overwritten if it's in the mask. If the
1032-
// user doesn't provide a mask then all fields are overwritten.
1027+
// Required. Field mask is used to specify the fields to be overwritten by the
1028+
// update in the `DeliveryPipeline` resource. The fields specified in the
1029+
// update_mask are relative to the resource, not the full request. A field
1030+
// will be overwritten if it's in the mask. If the user doesn't provide a mask
1031+
// then all fields are overwritten.
10331032
google.protobuf.FieldMask update_mask = 1
10341033
[(google.api.field_behavior) = REQUIRED];
10351034

@@ -1063,7 +1062,7 @@ message UpdateDeliveryPipelineRequest {
10631062

10641063
// The request object for `DeleteDeliveryPipeline`.
10651064
message DeleteDeliveryPipelineRequest {
1066-
// Required. The name of the `DeliveryPipeline` to delete. Format should be
1065+
// Required. The name of the `DeliveryPipeline` to delete. The format is
10671066
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
10681067
string name = 1 [
10691068
(google.api.field_behavior) = REQUIRED,
@@ -1118,8 +1117,8 @@ message RollbackTargetConfig {
11181117

11191118
// The request object for `RollbackTarget`.
11201119
message RollbackTargetRequest {
1121-
// Required. The `DeliveryPipeline` for which the rollback `Rollout` should be
1122-
// created. Format should be
1120+
// Required. The `DeliveryPipeline` for which the rollback `Rollout` must be
1121+
// created. The format is
11231122
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
11241123
string name = 1 [
11251124
(google.api.field_behavior) = REQUIRED,
@@ -1495,8 +1494,8 @@ message GetTargetRequest {
14951494

14961495
// The request object for `CreateTarget`.
14971496
message CreateTargetRequest {
1498-
// Required. The parent collection in which the `Target` should be created.
1499-
// Format should be
1497+
// Required. The parent collection in which the `Target` must be created.
1498+
// The format is
15001499
// `projects/{project_id}/locations/{location_name}`.
15011500
string parent = 1 [
15021501
(google.api.field_behavior) = REQUIRED,
@@ -1533,11 +1532,11 @@ message CreateTargetRequest {
15331532

15341533
// The request object for `UpdateTarget`.
15351534
message UpdateTargetRequest {
1536-
// Required. Field mask is used to specify the fields to be overwritten in the
1537-
// Target resource by the update.
1538-
// The fields specified in the update_mask are relative to the resource, not
1539-
// the full request. A field will be overwritten if it's in the mask. If the
1540-
// user doesn't provide a mask then all fields are overwritten.
1535+
// Required. Field mask is used to specify the fields to be overwritten by the
1536+
// update in the `Target` resource. The fields specified in the update_mask
1537+
// are relative to the resource, not the full request. A field will be
1538+
// overwritten if it's in the mask. If the user doesn't provide a mask then
1539+
// all fields are overwritten.
15411540
google.protobuf.FieldMask update_mask = 1
15421541
[(google.api.field_behavior) = REQUIRED];
15431542

@@ -1570,7 +1569,7 @@ message UpdateTargetRequest {
15701569

15711570
// The request object for `DeleteTarget`.
15721571
message DeleteTargetRequest {
1573-
// Required. The name of the `Target` to delete. Format should be
1572+
// Required. The name of the `Target` to delete. The format is
15741573
// `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
15751574
string name = 1 [
15761575
(google.api.field_behavior) = REQUIRED,
@@ -1813,9 +1812,8 @@ message GetCustomTargetTypeRequest {
18131812

18141813
// The request object for `CreateCustomTargetType`.
18151814
message CreateCustomTargetTypeRequest {
1816-
// Required. The parent collection in which the `CustomTargetType` should be
1817-
// created. Format should be
1818-
// `projects/{project_id}/locations/{location_name}`.
1815+
// Required. The parent collection in which the `CustomTargetType` must be
1816+
// created. The format is `projects/{project_id}/locations/{location_name}`.
18191817
string parent = 1 [
18201818
(google.api.field_behavior) = REQUIRED,
18211819
(google.api.resource_reference) = {
@@ -1852,11 +1850,11 @@ message CreateCustomTargetTypeRequest {
18521850

18531851
// The request object for `UpdateCustomTargetType`.
18541852
message UpdateCustomTargetTypeRequest {
1855-
// Required. Field mask is used to specify the fields to be overwritten in the
1856-
// `CustomTargetType` resource by the update.
1857-
// The fields specified in the update_mask are relative to the resource, not
1858-
// the full request. A field will be overwritten if it's in the mask. If the
1859-
// user doesn't provide a mask then all fields are overwritten.
1853+
// Required. Field mask is used to specify the fields to be overwritten by the
1854+
// update in the `CustomTargetType` resource. The fields specified in the
1855+
// update_mask are relative to the resource, not the full request. A field
1856+
// will be overwritten if it's in the mask. If the user doesn't provide a mask
1857+
// then all fields are overwritten.
18601858
google.protobuf.FieldMask update_mask = 1
18611859
[(google.api.field_behavior) = REQUIRED];
18621860

@@ -1945,8 +1943,8 @@ message DeployPolicy {
19451943
// Unspecified.
19461944
INVOKER_UNSPECIFIED = 0;
19471945

1948-
// The action is user-driven (e.g. creating a rollout manually via a gcloud
1949-
// create command).
1946+
// The action is user-driven. For example, creating a rollout manually via a
1947+
// gcloud create command.
19501948
USER = 1;
19511949

19521950
// Automated action by Cloud Deploy.
@@ -2027,9 +2025,9 @@ message DeployPolicy {
20272025

20282026
// Contains information on the resources to select for a deploy policy.
20292027
// Attributes provided must all match the resource in order for policy
2030-
// restrictions to apply. E.g. if delivery pipelines attributes given are an id
2031-
// "prod" and labels "foo: bar", a delivery pipeline resource must match both
2032-
// that id and have that label in order to be subject to the policy.
2028+
// restrictions to apply. For example, if delivery pipelines attributes given
2029+
// are an id "prod" and labels "foo: bar", a delivery pipeline resource must
2030+
// match both that id and have that label in order to be subject to the policy.
20332031
message DeployPolicyResourceSelector {
20342032
// Optional. Contains attributes about a delivery pipeline.
20352033
DeliveryPipelineAttribute delivery_pipeline = 1
@@ -2043,6 +2041,7 @@ message DeployPolicyResourceSelector {
20432041
message DeliveryPipelineAttribute {
20442042
// ID of the `DeliveryPipeline`. The value of this field could be one of the
20452043
// following:
2044+
//
20462045
// * The last segment of a pipeline name. It only needs the ID to determine
20472046
// which pipeline is being referred to
20482047
// * "*", all delivery pipelines in a location.
@@ -2056,6 +2055,7 @@ message DeliveryPipelineAttribute {
20562055
message TargetAttribute {
20572056
// ID of the `Target`. The value of this field could be one of the
20582057
// following:
2058+
//
20592059
// * The last segment of a target name. It only needs the ID to determine
20602060
// which target is being referred to
20612061
// * "*", all targets in a location.
@@ -2118,11 +2118,11 @@ message RestrictRollout {
21182118
// actions will be restricted.
21192119
repeated Actions actions = 3;
21202120

2121-
// Required. Time Window within which actions are restricted.
2121+
// Required. Time window within which actions are restricted.
21222122
TimeWindow time_window = 4 [(google.api.field_behavior) = REQUIRED];
21232123
}
21242124

2125-
// Time Window within which actions are restricted.
2125+
// Time window within which actions are restricted.
21262126
message TimeWindow {
21272127
// Required. The time zone in IANA format [IANA Time Zone
21282128
// Database](https://www.iana.org/time-zones) (e.g. America/New_York).
@@ -2418,9 +2418,8 @@ message Release {
24182418

24192419
// The request object for `CreateDeployPolicy`.
24202420
message CreateDeployPolicyRequest {
2421-
// Required. The parent collection in which the `DeployPolicy` should be
2422-
// created. Format should be
2423-
// `projects/{project_id}/locations/{location_name}`.
2421+
// Required. The parent collection in which the `DeployPolicy` must be
2422+
// created. The format is `projects/{project_id}/locations/{location_name}`.
24242423
string parent = 1 [
24252424
(google.api.field_behavior) = REQUIRED,
24262425
(google.api.resource_reference) = {
@@ -2456,11 +2455,11 @@ message CreateDeployPolicyRequest {
24562455

24572456
// The request object for `UpdateDeployPolicy`.
24582457
message UpdateDeployPolicyRequest {
2459-
// Required. Field mask is used to specify the fields to be overwritten in the
2460-
// `DeployPolicy` resource by the update.
2461-
// The fields specified in the update_mask are relative to the resource, not
2462-
// the full request. A field will be overwritten if it's in the mask. If the
2463-
// user doesn't provide a mask then all fields are overwritten.
2458+
// Required. Field mask is used to specify the fields to be overwritten by the
2459+
// update in the `DeployPolicy` resource. The fields specified in the
2460+
// update_mask are relative to the resource, not the full request. A field
2461+
// will be overwritten if it's in the mask. If the user doesn't provide a mask
2462+
// then all fields are overwritten.
24642463
google.protobuf.FieldMask update_mask = 1
24652464
[(google.api.field_behavior) = REQUIRED];
24662465

@@ -2493,7 +2492,7 @@ message UpdateDeployPolicyRequest {
24932492

24942493
// The request object for `DeleteDeployPolicy`.
24952494
message DeleteDeployPolicyRequest {
2496-
// Required. The name of the `DeployPolicy` to delete. Format should be
2495+
// Required. The name of the `DeployPolicy` to delete. The format is
24972496
// `projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}`.
24982497
string name = 1 [
24992498
(google.api.field_behavior) = REQUIRED,
@@ -2727,8 +2726,8 @@ message GetReleaseRequest {
27272726

27282727
// The request object for `CreateRelease`,
27292728
message CreateReleaseRequest {
2730-
// Required. The parent collection in which the `Release` should be created.
2731-
// Format should be
2729+
// Required. The parent collection in which the `Release` is created.
2730+
// The format is
27322731
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
27332732
string parent = 1 [
27342733
(google.api.field_behavior) = REQUIRED,
@@ -3294,8 +3293,8 @@ message GetRolloutRequest {
32943293

32953294
// CreateRolloutRequest is the request object used by `CreateRollout`.
32963295
message CreateRolloutRequest {
3297-
// Required. The parent collection in which the `Rollout` should be created.
3298-
// Format should be
3296+
// Required. The parent collection in which the `Rollout` must be created.
3297+
// The format is
32993298
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
33003299
string parent = 1 [
33013300
(google.api.field_behavior) = REQUIRED,
@@ -4073,8 +4072,8 @@ message AutomationRule {
40734072
}
40744073
}
40754074

4076-
// `PromoteRelease` rule will automatically promote a release from the current
4077-
// target to a specified target.
4075+
// The `PromoteRelease` rule will automatically promote a release from the
4076+
// current target to a specified target.
40784077
message PromoteReleaseRule {
40794078
// Required. ID of the rule. This id must be unique in the `Automation`
40804079
// resource to which this rule belongs. The format is
@@ -4204,8 +4203,8 @@ message AutomationRuleCondition {
42044203

42054204
// The request object for `CreateAutomation`.
42064205
message CreateAutomationRequest {
4207-
// Required. The parent collection in which the `Automation` should be
4208-
// created. Format should be
4206+
// Required. The parent collection in which the `Automation` must be created.
4207+
// The format is
42094208
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
42104209
string parent = 1 [
42114210
(google.api.field_behavior) = REQUIRED,
@@ -4242,11 +4241,11 @@ message CreateAutomationRequest {
42424241

42434242
// The request object for `UpdateAutomation`.
42444243
message UpdateAutomationRequest {
4245-
// Required. Field mask is used to specify the fields to be overwritten in the
4246-
// `Automation` resource by the update.
4247-
// The fields specified in the update_mask are relative to the resource, not
4248-
// the full request. A field will be overwritten if it's in the mask. If the
4249-
// user doesn't provide a mask then all fields are overwritten.
4244+
// Required. Field mask is used to specify the fields to be overwritten by the
4245+
// update in the `Automation` resource. The fields specified in the
4246+
// update_mask are relative to the resource, not the full request. A field
4247+
// will be overwritten if it's in the mask. If the user doesn't provide a mask
4248+
// then all fields are overwritten.
42504249
google.protobuf.FieldMask update_mask = 1
42514250
[(google.api.field_behavior) = REQUIRED];
42524251

@@ -4279,7 +4278,7 @@ message UpdateAutomationRequest {
42794278

42804279
// The request object for `DeleteAutomation`.
42814280
message DeleteAutomationRequest {
4282-
// Required. The name of the `Automation` to delete. Format should be
4281+
// Required. The name of the `Automation` to delete. The format is
42834282
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
42844283
string name = 1 [
42854284
(google.api.field_behavior) = REQUIRED,
@@ -4405,6 +4404,9 @@ message AutomationRun {
44054404

44064405
// The `AutomationRun` is pending.
44074406
PENDING = 5;
4407+
4408+
// The `AutomationRun` was aborted.
4409+
ABORTED = 6;
44084410
}
44094411

44104412
// Output only. Name of the `AutomationRun`. Format is

‎packages/google-cloud-deploy/protos/google/cloud/deploy/v1/customtargettype_notification_payload.proto‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
// Copyright 2024 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
15+
syntax = "proto3";
16+
17+
package google.cloud.deploy.v1;
18+
19+
import "google/cloud/deploy/v1/log_enums.proto";
20+
21+
option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
22+
option java_multiple_files = true;
23+
option java_outer_classname = "CustomTargetTypeNotificationPayloadProto";
24+
option java_package = "com.google.cloud.deploy.v1";
25+
26+
// Payload proto for "clouddeploy.googleapis.com/customtargettype_notification"
27+
// Platform Log event that describes the failure to send a custom target type
28+
// status change Pub/Sub notification.
29+
message CustomTargetTypeNotificationEvent {
30+
// Debug message for when a notification fails to send.
31+
string message = 1;
32+
33+
// Unique identifier of the `CustomTargetType`.
34+
string custom_target_type_uid = 4;
35+
36+
// The name of the `CustomTargetType`.
37+
string custom_target_type = 2;
38+
39+
// Type of this notification, e.g. for a Pub/Sub failure.
40+
Type type = 3;
41+
}

0 commit comments

Comments
 (0)