Skip to content

Commit 2d60c59

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: clarified when revision_id of a workflow is updated
docs: clarified format and semantics of service_account field docs: documented expanded workflow size limit PiperOrigin-RevId: 404237609
1 parent c8fba4b commit 2d60c59

4 files changed

Lines changed: 58 additions & 19 deletions

File tree

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

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# This file was automatically generated by BuildFileGenerator
2-
# https://github.com/googleapis/gapic-generator/tree/master/rules_gapic/bazel
2+
# https://github.com/googleapis/rules_gapic/tree/master/bazel
33

44
# Most of the manual changes to this file will be overwritten.
55
# It's **only** allowed to change the following rule attribute values:
@@ -68,12 +68,15 @@ java_grpc_library(
6868
java_gapic_library(
6969
name = "workflows_java_gapic",
7070
srcs = [":workflows_proto_with_info"],
71+
gapic_yaml = "workflows_gapic.yaml",
7172
grpc_service_config = "workflows_grpc_service_config.json",
73+
service_yaml = "workflows_v1.yaml",
7274
test_deps = [
7375
":workflows_java_grpc",
7476
],
7577
deps = [
7678
":workflows_java_proto",
79+
"//google/api:api_java_proto",
7780
],
7881
)
7982

@@ -123,6 +126,7 @@ go_gapic_library(
123126
srcs = [":workflows_proto_with_info"],
124127
grpc_service_config = "workflows_grpc_service_config.json",
125128
importpath = "cloud.google.com/go/workflows/apiv1;workflows",
129+
metadata = True,
126130
service_yaml = "workflows_v1.yaml",
127131
deps = [
128132
":workflows_go_proto",
@@ -144,6 +148,7 @@ go_gapic_assembly_pkg(
144148
name = "gapi-cloud-workflows-v1-go",
145149
deps = [
146150
":workflows_go_gapic",
151+
":workflows_go_gapic_srcjar-metadata.srcjar",
147152
":workflows_go_gapic_srcjar-test.srcjar",
148153
":workflows_go_proto",
149154
],
@@ -198,6 +203,7 @@ php_gapic_library(
198203
name = "workflows_php_gapic",
199204
srcs = [":workflows_proto_with_info"],
200205
grpc_service_config = "workflows_grpc_service_config.json",
206+
service_yaml = "workflows_v1.yaml",
201207
deps = [
202208
":workflows_php_grpc",
203209
":workflows_php_proto",
@@ -247,8 +253,8 @@ nodejs_gapic_assembly_pkg(
247253
##############################################################################
248254
load(
249255
"@com_google_googleapis_imports//:imports.bzl",
250-
"ruby_gapic_assembly_pkg",
251256
"ruby_cloud_gapic_library",
257+
"ruby_gapic_assembly_pkg",
252258
"ruby_grpc_library",
253259
"ruby_proto_library",
254260
)
@@ -266,13 +272,13 @@ ruby_grpc_library(
266272

267273
ruby_cloud_gapic_library(
268274
name = "workflows_ruby_gapic",
269-
srcs = [":workflows_proto_with_info",],
275+
srcs = [":workflows_proto_with_info"],
270276
extra_protoc_parameters = [
271-
"ruby-cloud-gem-name=google-cloud-workflows-v1",
272-
"ruby-cloud-env-prefix=WORKFLOWS",
273-
"ruby-cloud-product-url=https://cloud.google.com/workflows/",
274277
"ruby-cloud-api-id=workflows.googleapis.com",
275278
"ruby-cloud-api-shortname=workflows",
279+
"ruby-cloud-env-prefix=WORKFLOWS",
280+
"ruby-cloud-gem-name=google-cloud-workflows-v1",
281+
"ruby-cloud-product-url=https://cloud.google.com/workflows/",
276282
],
277283
grpc_service_config = "workflows_grpc_service_config.json",
278284
ruby_cloud_description = "Workflows link series of serverless tasks together in an order you define. Combine the power of Google Cloud's APIs, serverless products like Cloud Functions and Cloud Run, and calls to external APIs to create flexible serverless applications. Workflows requires no infrastructure management and scales seamlessly with demand, including scaling down to zero..",

‎google/cloud/workflows/v1/workflows.proto‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2020 Google LLC
1+
// Copyright 2021 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -130,9 +130,11 @@ message Workflow {
130130

131131
// Output only. The revision of the workflow.
132132
// A new revision of a workflow is created as a result of updating the
133-
// following fields of a workflow:
134-
// - `source_code`
135-
// - `service_account`
133+
// following properties of a workflow:
134+
//
135+
// - [Service account][google.cloud.workflows.v1.Workflow.service_account]
136+
// - [Workflow code to be executed][google.cloud.workflows.v1.Workflow.source_contents]
137+
//
136138
// The format is "000001-a4d", where the first 6 characters define
137139
// the zero-padded revision ordinal number. They are followed by a hyphen and
138140
// 3 hexadecimal random characters.
@@ -155,14 +157,14 @@ message Workflow {
155157
// International characters are allowed.
156158
map<string, string> labels = 8;
157159

158-
// Name of the service account associated with the latest workflow version.
160+
// The service account associated with the latest workflow version.
159161
// This service account represents the identity of the workflow and determines
160162
// what permissions the workflow has.
161-
// Format: projects/{project}/serviceAccounts/{account}
163+
// Format: projects/{project}/serviceAccounts/{account} or {account}
162164
//
163-
// Using `-` as a wildcard for the `{project}` will infer the project from
164-
// the account. The `{account}` value can be the `email` address or the
165-
// `unique_id` of the service account.
165+
// Using `-` as a wildcard for the `{project}` or not providing one at all
166+
// will infer the project from the account. The `{account}` value can be the
167+
// `email` address or the `unique_id` of the service account.
166168
//
167169
// If not provided, workflow will use the project's default service account.
168170
// Modifying this field for an existing workflow results in a new workflow
@@ -173,7 +175,7 @@ message Workflow {
173175
// Modifying this field for an existing workflow results in a new workflow
174176
// revision.
175177
oneof source_code {
176-
// Workflow code to be executed. The size limit is 32KB.
178+
// Workflow code to be executed. The size limit is 128KB.
177179
string source_contents = 10;
178180
}
179181
}

‎google/cloud/workflows/v1/workflows_grpc_service_config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"retryPolicy": {
99
"maxAttempts": 5,
1010
"initialBackoff": "1s",
11-
"maxBackoff": "10s",
11+
"maxBackoff": "60s",
1212
"backoffMultiplier": 1.3,
1313
"retryableStatusCodes": ["UNAVAILABLE"]
1414
}

‎google/cloud/workflows/v1/workflows_v1.yaml‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,51 @@ types:
1111

1212
documentation:
1313
summary: |-
14-
Orchestrate Workflows that invoke Google Cloud APIs, SaaS APIs or private
15-
API endpoints.
14+
Manage workflow definitions. To execute workflows and manage executions,
15+
see the Workflows Executions API.
16+
rules:
17+
- selector: google.cloud.location.Locations.GetLocation
18+
description: Gets information about a location.
19+
20+
- selector: google.cloud.location.Locations.ListLocations
21+
description: Lists information about the supported locations for this service.
1622

1723
backend:
1824
rules:
25+
- selector: google.cloud.location.Locations.GetLocation
26+
deadline: 60.0
27+
- selector: google.cloud.location.Locations.ListLocations
28+
deadline: 60.0
1929
- selector: 'google.cloud.workflows.v1.Workflows.*'
2030
deadline: 60.0
2131
- selector: 'google.longrunning.Operations.*'
2232
deadline: 60.0
2333
- selector: google.longrunning.Operations.GetOperation
2434
deadline: 5.0
2535

36+
http:
37+
rules:
38+
- selector: google.cloud.location.Locations.GetLocation
39+
get: '/v1/{name=projects/*/locations/*}'
40+
- selector: google.cloud.location.Locations.ListLocations
41+
get: '/v1/{name=projects/*}/locations'
42+
- selector: google.longrunning.Operations.DeleteOperation
43+
delete: '/v1/{name=projects/*/locations/*/operations/*}'
44+
- selector: google.longrunning.Operations.GetOperation
45+
get: '/v1/{name=projects/*/locations/*/operations/*}'
46+
- selector: google.longrunning.Operations.ListOperations
47+
get: '/v1/{name=projects/*/locations/*}/operations'
48+
2649
authentication:
2750
rules:
51+
- selector: google.cloud.location.Locations.GetLocation
52+
oauth:
53+
canonical_scopes: |-
54+
https://www.googleapis.com/auth/cloud-platform
55+
- selector: google.cloud.location.Locations.ListLocations
56+
oauth:
57+
canonical_scopes: |-
58+
https://www.googleapis.com/auth/cloud-platform
2859
- selector: 'google.cloud.workflows.v1.Workflows.*'
2960
oauth:
3061
canonical_scopes: |-

0 commit comments

Comments
 (0)