Skip to content

Commit 11d5ead

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat:Publish Workflows execution logging proto for documentation
PiperOrigin-RevId: 386290605
1 parent b1844c9 commit 11d5ead

2 files changed

Lines changed: 248 additions & 0 deletions

File tree

‎google/cloud/workflows/type/BUILD.bazel‎

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
# This file was automatically generated by BuildFileGenerator
2+
3+
# This is an API workspace, having public visibility by default makes perfect sense.
4+
package(default_visibility = ["//visibility:public"])
5+
6+
##############################################################################
7+
# Common
8+
##############################################################################
9+
load("@rules_proto//proto:defs.bzl", "proto_library")
10+
11+
proto_library(
12+
name = "type_proto",
13+
srcs = [
14+
"executions_system.proto",
15+
],
16+
deps = [
17+
"@com_google_protobuf//:timestamp_proto",
18+
],
19+
)
20+
21+
##############################################################################
22+
# Java
23+
##############################################################################
24+
load(
25+
"@com_google_googleapis_imports//:imports.bzl",
26+
"java_grpc_library",
27+
"java_proto_library",
28+
)
29+
30+
java_proto_library(
31+
name = "type_java_proto",
32+
deps = [":type_proto"],
33+
)
34+
35+
java_grpc_library(
36+
name = "type_java_grpc",
37+
srcs = [":type_proto"],
38+
deps = [":type_java_proto"],
39+
)
40+
41+
##############################################################################
42+
# Go
43+
##############################################################################
44+
load(
45+
"@com_google_googleapis_imports//:imports.bzl",
46+
"go_proto_library",
47+
)
48+
49+
go_proto_library(
50+
name = "type_go_proto",
51+
compilers = ["@io_bazel_rules_go//proto:go_grpc"],
52+
importpath = "google.golang.org/genproto/googleapis/cloud/workflows/type",
53+
protos = [":type_proto"],
54+
deps = [
55+
56+
],
57+
)
58+
59+
##############################################################################
60+
# Python
61+
##############################################################################
62+
load(
63+
"@com_google_googleapis_imports//:imports.bzl",
64+
"moved_proto_library",
65+
"py_grpc_library",
66+
"py_proto_library",
67+
)
68+
69+
moved_proto_library(
70+
name = "type_moved_proto",
71+
srcs = [":type_proto"],
72+
deps = [
73+
"@com_google_protobuf//:timestamp_proto",
74+
],
75+
)
76+
77+
py_proto_library(
78+
name = "type_py_proto",
79+
deps = [":type_moved_proto"],
80+
)
81+
82+
py_grpc_library(
83+
name = "type_py_grpc",
84+
srcs = [":type_moved_proto"],
85+
deps = [":type_py_proto"],
86+
)
87+
88+
##############################################################################
89+
# PHP
90+
##############################################################################
91+
load(
92+
"@com_google_googleapis_imports//:imports.bzl",
93+
"php_grpc_library",
94+
"php_proto_library",
95+
)
96+
97+
php_proto_library(
98+
name = "type_php_proto",
99+
deps = [":type_proto"],
100+
)
101+
102+
php_grpc_library(
103+
name = "type_php_grpc",
104+
srcs = [":type_proto"],
105+
deps = [":type_php_proto"],
106+
)
107+
108+
##############################################################################
109+
# Node.js
110+
##############################################################################
111+
load(
112+
"@com_google_googleapis_imports//:imports.bzl",
113+
"nodejs_gapic_assembly_pkg",
114+
"nodejs_gapic_library",
115+
)
116+
117+
118+
##############################################################################
119+
# Ruby
120+
##############################################################################
121+
load(
122+
"@com_google_googleapis_imports//:imports.bzl",
123+
"ruby_grpc_library",
124+
"ruby_proto_library",
125+
)
126+
127+
ruby_proto_library(
128+
name = "type_ruby_proto",
129+
deps = [":type_proto"],
130+
)
131+
132+
ruby_grpc_library(
133+
name = "type_ruby_grpc",
134+
srcs = [":type_proto"],
135+
deps = [":type_ruby_proto"],
136+
)
137+
138+
##############################################################################
139+
# C#
140+
##############################################################################
141+
load(
142+
"@com_google_googleapis_imports//:imports.bzl",
143+
"csharp_grpc_library",
144+
"csharp_proto_library",
145+
)
146+
147+
csharp_proto_library(
148+
name = "type_csharp_proto",
149+
deps = [":type_proto"],
150+
)
151+
152+
csharp_grpc_library(
153+
name = "type_csharp_grpc",
154+
srcs = [":type_proto"],
155+
deps = [":type_csharp_proto"],
156+
)
157+
158+
##############################################################################
159+
# C++
160+
##############################################################################
161+
# Put your C++ code here

‎google/cloud/workflows/type/executions_system.proto‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
// Copyright 2021 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.workflows.type;
18+
19+
import "google/protobuf/timestamp.proto";
20+
21+
option go_package = "google.golang.org/genproto/googleapis/cloud/workflows/type";
22+
23+
// Logged during the lifetime of Workflow Execution.
24+
message ExecutionsSystemLog {
25+
// Detailed information about the start of the execution.
26+
message Start {
27+
// The execution input argument.
28+
string argument = 2;
29+
}
30+
31+
// Detailed information about the successful finish of the execution.
32+
message Success {
33+
// The final result of the execution.
34+
string result = 2;
35+
}
36+
37+
// Detailed information about the execution failure.
38+
message Failure {
39+
// The exception message, e.g. "division by zero". The size limit is 1 kB.
40+
string exception = 1;
41+
42+
// The code location of the statement that has created the log. For example,
43+
// a log created in subworkflow 'Foo' in step 'bar' will have its source
44+
// equal to 'Foo.bar'. The size limit is 1 kB.
45+
string source = 2;
46+
}
47+
48+
// Possible states of the execution. There could be more states in the future.
49+
enum State {
50+
// Invalid state.
51+
STATE_UNSPECIFIED = 0;
52+
53+
// The Workflow Execution is in progress.
54+
ACTIVE = 1;
55+
56+
// The Workflow Execution has finished successfully.
57+
SUCCEEDED = 2;
58+
59+
// The Workflow Execution failed with an error.
60+
FAILED = 3;
61+
62+
// The Workflow Execution has been stopped intentionally.
63+
CANCELLED = 4;
64+
}
65+
66+
// Human readable contents of the log in English. The size limit is 5 kB.
67+
string message = 1;
68+
69+
// The absolute point in time when the activity happened.
70+
google.protobuf.Timestamp activity_time = 2;
71+
72+
// State of the execution when the log was created.
73+
State state = 3;
74+
75+
// Detailed log information.
76+
oneof details {
77+
// Appears only in the log created when the execution has started.
78+
Start start = 4;
79+
80+
// Appears only in the log created when the execution has finished
81+
// successfully.
82+
Success success = 5;
83+
84+
// Appears only in the log created when the execution has failed.
85+
Failure failure = 6;
86+
}
87+
}

0 commit comments

Comments
 (0)