xref: /aosp_15_r20/external/googleapis/google/cloud/deploy/v1/rollout_update_payload.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 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
15syntax = "proto3";
16
17package google.cloud.deploy.v1;
18
19import "google/cloud/deploy/v1/log_enums.proto";
20
21option go_package = "cloud.google.com/go/deploy/apiv1/deploypb;deploypb";
22option java_multiple_files = true;
23option java_outer_classname = "RolloutUpdatePayloadProto";
24option java_package = "com.google.cloud.deploy.v1";
25
26// Payload proto for "clouddeploy.googleapis.com/rollout_update"
27// Platform Log event that describes the rollout update event.
28message RolloutUpdateEvent {
29  // RolloutUpdateType indicates the type of the rollout update.
30  enum RolloutUpdateType {
31    // Rollout update type unspecified.
32    ROLLOUT_UPDATE_TYPE_UNSPECIFIED = 0;
33
34    // rollout state updated to pending.
35    PENDING = 1;
36
37    // Rollout state updated to pending release.
38    PENDING_RELEASE = 2;
39
40    // Rollout state updated to in progress.
41    IN_PROGRESS = 3;
42
43    // Rollout state updated to cancelling.
44    CANCELLING = 4;
45
46    // Rollout state updated to cancelled.
47    CANCELLED = 5;
48
49    // Rollout state updated to halted.
50    HALTED = 6;
51
52    // Rollout state updated to succeeded.
53    SUCCEEDED = 7;
54
55    // Rollout state updated to failed.
56    FAILED = 8;
57
58    // Rollout requires approval.
59    APPROVAL_REQUIRED = 9;
60
61    // Rollout has been approved.
62    APPROVED = 10;
63
64    // Rollout has been rejected.
65    REJECTED = 11;
66
67    // Rollout requires advance to the next phase.
68    ADVANCE_REQUIRED = 12;
69
70    // Rollout has been advanced.
71    ADVANCED = 13;
72  }
73
74  // Debug message for when a rollout update event occurs.
75  string message = 6;
76
77  // Unique identifier of the pipeline.
78  string pipeline_uid = 1;
79
80  // Unique identifier of the release.
81  string release_uid = 2;
82
83  // The name of the `Release`.
84  string release = 8;
85
86  // The name of the rollout.
87  // rollout_uid is not in this log message because we write some of these log
88  // messages at rollout creation time, before we've generated the uid.
89  string rollout = 3;
90
91  // ID of the target.
92  string target_id = 4;
93
94  // Type of this notification, e.g. for a rollout update event.
95  Type type = 7;
96
97  // The type of the rollout update.
98  RolloutUpdateType rollout_update_type = 5;
99}
100