xref: /aosp_15_r20/external/googleapis/google/devtools/cloudbuild/v2/cloudbuild.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2022 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.devtools.cloudbuild.v2;
18
19import "google/api/annotations.proto";
20import "google/api/client.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23import "google/protobuf/timestamp.proto";
24
25option csharp_namespace = "Google.Cloud.CloudBuild.V2";
26option go_package = "cloud.google.com/go/cloudbuild/apiv2/cloudbuildpb;cloudbuildpb";
27option java_multiple_files = true;
28option java_outer_classname = "CloudBuildProto";
29option java_package = "com.google.cloudbuild.v2";
30option objc_class_prefix = "GCB";
31option php_namespace = "Google\\Cloud\\Build\\V2";
32option ruby_package = "Google::Cloud::Build::V2";
33option (google.api.resource_definition) = {
34  type: "compute.googleapis.com/Network"
35  pattern: "projects/{project}/global/networks/{network}"
36};
37option (google.api.resource_definition) = {
38  type: "iam.googleapis.com/ServiceAccount"
39  pattern: "projects/{project}/serviceAccounts/{service_account}"
40};
41option (google.api.resource_definition) = {
42  type: "secretmanager.googleapis.com/Secret"
43  pattern: "projects/{project}/secrets/{secret}"
44};
45option (google.api.resource_definition) = {
46  type: "secretmanager.googleapis.com/SecretVersion"
47  pattern: "projects/{project}/secrets/{secret}/versions/{version}"
48};
49option (google.api.resource_definition) = {
50  type: "cloudbuild.googleapis.com/githubEnterpriseConfig"
51  pattern: "projects/{project}/locations/{location}/githubEnterpriseConfigs/{config}"
52};
53
54// Represents the metadata of the long-running operation.
55message OperationMetadata {
56  // Output only. The time the operation was created.
57  google.protobuf.Timestamp create_time = 1
58      [(google.api.field_behavior) = OUTPUT_ONLY];
59
60  // Output only. The time the operation finished running.
61  google.protobuf.Timestamp end_time = 2
62      [(google.api.field_behavior) = OUTPUT_ONLY];
63
64  // Output only. Server-defined resource path for the target of the operation.
65  string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
66
67  // Output only. Name of the verb executed by the operation.
68  string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
69
70  // Output only. Human-readable status of the operation, if any.
71  string status_message = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
72
73  // Output only. Identifies whether the user has requested cancellation
74  // of the operation. Operations that have successfully been cancelled
75  // have [Operation.error][] value with a
76  // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
77  // `Code.CANCELLED`.
78  bool requested_cancellation = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
79
80  // Output only. API version used to start the operation.
81  string api_version = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
82}
83
84// Represents the custom metadata of the RunWorkflow long-running operation.
85message RunWorkflowCustomOperationMetadata {
86  // Output only. The time the operation was created.
87  google.protobuf.Timestamp create_time = 1
88      [(google.api.field_behavior) = OUTPUT_ONLY];
89
90  // Output only. The time the operation finished running.
91  google.protobuf.Timestamp end_time = 2
92      [(google.api.field_behavior) = OUTPUT_ONLY];
93
94  // Output only. Name of the verb executed by the operation.
95  string verb = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
96
97  // Output only. Identifies whether the user has requested cancellation
98  // of the operation. Operations that have successfully been cancelled
99  // have [Operation.error][] value with a
100  // [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
101  // `Code.CANCELLED`.
102  bool requested_cancellation = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
103
104  // Output only. API version used to start the operation.
105  string api_version = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
106
107  // Output only. Server-defined resource path for the target of the operation.
108  string target = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
109
110  // Output only. ID of the pipeline run created by RunWorkflow.
111  string pipeline_run_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
112}
113