Skip to content

Commit

Permalink
feat: [deploy] added support for new custom target type and deploy po…
Browse files Browse the repository at this point in the history 
…licy 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>
  • Loading branch information
@gcf-owl-bot
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Jul 17, 2024
1 parent 2c4325f commit 6deeeed
Show file tree
Hide file tree
Showing 27 changed files with 2,132 additions and 158 deletions.
116 changes: 59 additions & 57 deletions packages/google-cloud-deploy/protos/google/cloud/deploy/v1/cloud_deploy.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -986,9 +986,8 @@ message GetDeliveryPipelineRequest {

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

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

Expand Down Expand Up @@ -1063,7 +1062,7 @@ message UpdateDeliveryPipelineRequest {

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

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

// The request object for `CreateTarget`.
message CreateTargetRequest {
// Required. The parent collection in which the `Target` should be created.
// Format should be
// Required. The parent collection in which the `Target` must be created.
// The format is
// `projects/{project_id}/locations/{location_name}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -1533,11 +1532,11 @@ message CreateTargetRequest {

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

Expand Down Expand Up @@ -1570,7 +1569,7 @@ message UpdateTargetRequest {

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

// The request object for `CreateCustomTargetType`.
message CreateCustomTargetTypeRequest {
// Required. The parent collection in which the `CustomTargetType` should be
// created. Format should be
// `projects/{project_id}/locations/{location_name}`.
// Required. The parent collection in which the `CustomTargetType` must be
// created. The format is `projects/{project_id}/locations/{location_name}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
Expand Down Expand Up @@ -1852,11 +1850,11 @@ message CreateCustomTargetTypeRequest {

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

Expand Down Expand Up @@ -1945,8 +1943,8 @@ message DeployPolicy {
// Unspecified.
INVOKER_UNSPECIFIED = 0;

// The action is user-driven (e.g. creating a rollout manually via a gcloud
// create command).
// The action is user-driven. For example, creating a rollout manually via a
// gcloud create command.
USER = 1;

// Automated action by Cloud Deploy.
Expand Down Expand Up @@ -2027,9 +2025,9 @@ message DeployPolicy {

// Contains information on the resources to select for a deploy policy.
// Attributes provided must all match the resource in order for policy
// restrictions to apply. E.g. if delivery pipelines attributes given are an id
// "prod" and labels "foo: bar", a delivery pipeline resource must match both
// that id and have that label in order to be subject to the policy.
// restrictions to apply. For example, if delivery pipelines attributes given
// are an id "prod" and labels "foo: bar", a delivery pipeline resource must
// match both that id and have that label in order to be subject to the policy.
message DeployPolicyResourceSelector {
// Optional. Contains attributes about a delivery pipeline.
DeliveryPipelineAttribute delivery_pipeline = 1
Expand All @@ -2043,6 +2041,7 @@ message DeployPolicyResourceSelector {
message DeliveryPipelineAttribute {
// ID of the `DeliveryPipeline`. The value of this field could be one of the
// following:
//
// * The last segment of a pipeline name. It only needs the ID to determine
// which pipeline is being referred to
// * "*", all delivery pipelines in a location.
Expand All @@ -2056,6 +2055,7 @@ message DeliveryPipelineAttribute {
message TargetAttribute {
// ID of the `Target`. The value of this field could be one of the
// following:
//
// * The last segment of a target name. It only needs the ID to determine
// which target is being referred to
// * "*", all targets in a location.
Expand Down Expand Up @@ -2118,11 +2118,11 @@ message RestrictRollout {
// actions will be restricted.
repeated Actions actions = 3;

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

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

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

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

Expand Down Expand Up @@ -2493,7 +2492,7 @@ message UpdateDeployPolicyRequest {

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

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

// CreateRolloutRequest is the request object used by `CreateRollout`.
message CreateRolloutRequest {
// Required. The parent collection in which the `Rollout` should be created.
// Format should be
// Required. The parent collection in which the `Rollout` must be created.
// The format is
// `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
Expand Down Expand Up @@ -4073,8 +4072,8 @@ message AutomationRule {
}
}

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

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

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

Expand Down Expand Up @@ -4279,7 +4278,7 @@ message UpdateAutomationRequest {

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

// The `AutomationRun` is pending.
PENDING = 5;

// The `AutomationRun` was aborted.
ABORTED = 6;
}

// Output only. Name of the `AutomationRun`. Format is
Expand Down
41 changes: 41 additions & 0 deletions ...le-cloud-deploy/protos/google/cloud/deploy/v1/customtargettype_notification_payload.proto
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.cloud.deploy.v1;

import "google/cloud/deploy/v1/log_enums.proto";

option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
option java_multiple_files = true;
option java_outer_classname = "CustomTargetTypeNotificationPayloadProto";
option java_package = "com.google.cloud.deploy.v1";

// Payload proto for "clouddeploy.googleapis.com/customtargettype_notification"
// Platform Log event that describes the failure to send a custom target type
// status change Pub/Sub notification.
message CustomTargetTypeNotificationEvent {
// Debug message for when a notification fails to send.
string message = 1;

// Unique identifier of the `CustomTargetType`.
string custom_target_type_uid = 4;

// The name of the `CustomTargetType`.
string custom_target_type = 2;

// Type of this notification, e.g. for a Pub/Sub failure.
Type type = 3;
}
Loading

0 comments on commit 6deeeed

Please sign in to comment.