Skip to content

Commit febcd2b

Browse files
Google APIscopybara-github
authored andcommitted
docs: A comment for field revision_id in message .google.cloud.workflows.v1beta.Workflow is changed
docs: A comment for field `service_account` in message `.google.cloud.workflows.v1beta.Workflow` is changed docs: A comment for field `source_contents` in message `.google.cloud.workflows.v1beta.Workflow` is changed PiperOrigin-RevId: 743585163
1 parent a9e06ec commit febcd2b

2 files changed

Lines changed: 29 additions & 29 deletions

File tree

google/cloud/workflows/v1beta/workflows.proto

Lines changed: 27 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import "google/api/client.proto";
2121
import "google/api/field_behavior.proto";
2222
import "google/api/resource.proto";
2323
import "google/longrunning/operations.proto";
24+
import "google/protobuf/empty.proto";
2425
import "google/protobuf/field_mask.proto";
2526
import "google/protobuf/timestamp.proto";
2627

@@ -34,7 +35,8 @@ option java_package = "com.google.cloud.workflows.v1beta";
3435
// networking interruptions.
3536
service Workflows {
3637
option (google.api.default_host) = "workflows.googleapis.com";
37-
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
38+
option (google.api.oauth_scopes) =
39+
"https://www.googleapis.com/auth/cloud-platform";
3840

3941
// Lists Workflows in a given project and location.
4042
// The default order is not specified.
@@ -56,7 +58,8 @@ service Workflows {
5658
// Creates a new workflow. If a workflow with the specified name already
5759
// exists in the specified project and location, the long running operation
5860
// will return [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS] error.
59-
rpc CreateWorkflow(CreateWorkflowRequest) returns (google.longrunning.Operation) {
61+
rpc CreateWorkflow(CreateWorkflowRequest)
62+
returns (google.longrunning.Operation) {
6063
option (google.api.http) = {
6164
post: "/v1beta/{parent=projects/*/locations/*}/workflows"
6265
body: "workflow"
@@ -71,7 +74,8 @@ service Workflows {
7174
// Deletes a workflow with the specified name.
7275
// This method also cancels and deletes all running executions of the
7376
// workflow.
74-
rpc DeleteWorkflow(DeleteWorkflowRequest) returns (google.longrunning.Operation) {
77+
rpc DeleteWorkflow(DeleteWorkflowRequest)
78+
returns (google.longrunning.Operation) {
7579
option (google.api.http) = {
7680
delete: "/v1beta/{name=projects/*/locations/*/workflows/*}"
7781
};
@@ -87,7 +91,8 @@ service Workflows {
8791
// workflow. A new revision of the workflow may be created as a result of a
8892
// successful update operation. In that case, such revision will be used
8993
// in new workflow executions.
90-
rpc UpdateWorkflow(UpdateWorkflowRequest) returns (google.longrunning.Operation) {
94+
rpc UpdateWorkflow(UpdateWorkflowRequest)
95+
returns (google.longrunning.Operation) {
9196
option (google.api.http) = {
9297
patch: "/v1beta/{workflow.name=projects/*/locations/*/workflows/*}"
9398
body: "workflow"
@@ -130,23 +135,29 @@ message Workflow {
130135

131136
// Output only. The revision of the workflow.
132137
// 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`
138+
// following properties of a workflow:
139+
//
140+
// - [Service account][google.cloud.workflows.v1beta.Workflow.service_account]
141+
// - [Workflow code to be
142+
// executed][google.cloud.workflows.v1beta.Workflow.source_contents]
143+
//
136144
// The format is "000001-a4d", where the first 6 characters define
137145
// the zero-padded revision ordinal number. They are followed by a hyphen and
138146
// 3 hexadecimal random characters.
139147
string revision_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
140148

141149
// Output only. The timestamp of when the workflow was created.
142-
google.protobuf.Timestamp create_time = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
150+
google.protobuf.Timestamp create_time = 5
151+
[(google.api.field_behavior) = OUTPUT_ONLY];
143152

144153
// Output only. The last update timestamp of the workflow.
145-
google.protobuf.Timestamp update_time = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
154+
google.protobuf.Timestamp update_time = 6
155+
[(google.api.field_behavior) = OUTPUT_ONLY];
146156

147157
// Output only. The timestamp that the latest revision of the workflow
148158
// was created.
149-
google.protobuf.Timestamp revision_create_time = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
159+
google.protobuf.Timestamp revision_create_time = 7
160+
[(google.api.field_behavior) = OUTPUT_ONLY];
150161

151162
// Labels associated with this workflow.
152163
// Labels can contain at most 64 entries. Keys and values can be no longer
@@ -155,14 +166,14 @@ message Workflow {
155166
// International characters are allowed.
156167
map<string, string> labels = 8;
157168

158-
// Name of the service account associated with the latest workflow version.
169+
// The service account associated with the latest workflow version.
159170
// This service account represents the identity of the workflow and determines
160171
// what permissions the workflow has.
161-
// Format: projects/{project}/serviceAccounts/{account}
172+
// Format: projects/{project}/serviceAccounts/{account} or {account}
162173
//
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.
174+
// Using `-` as a wildcard for the `{project}` or not providing one at all
175+
// will infer the project from the account. The `{account}` value can be the
176+
// `email` address or the `unique_id` of the service account.
166177
//
167178
// If not provided, workflow will use the project's default service account.
168179
// Modifying this field for an existing workflow results in a new workflow
@@ -173,7 +184,7 @@ message Workflow {
173184
// Modifying this field for an existing workflow results in a new workflow
174185
// revision.
175186
oneof source_code {
176-
// Workflow code to be executed. The size limit is 32KB.
187+
// Workflow code to be executed. The size limit is 128KB.
177188
string source_contents = 10;
178189
}
179190
}

google/cloud/workflows/v1beta/workflows_v1beta.yaml

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ name: workflows.googleapis.com
44
title: Workflows API
55

66
apis:
7+
- name: google.cloud.location.Locations
78
- name: google.cloud.workflows.v1beta.Workflows
9+
- name: google.longrunning.Operations
810

911
types:
1012
- name: google.cloud.workflows.v1beta.OperationMetadata
@@ -20,19 +22,6 @@ documentation:
2022
- selector: google.cloud.location.Locations.ListLocations
2123
description: Lists information about the supported locations for this service.
2224

23-
backend:
24-
rules:
25-
- selector: google.cloud.location.Locations.GetLocation
26-
deadline: 60.0
27-
- selector: google.cloud.location.Locations.ListLocations
28-
deadline: 60.0
29-
- selector: 'google.cloud.workflows.v1beta.Workflows.*'
30-
deadline: 60.0
31-
- selector: 'google.longrunning.Operations.*'
32-
deadline: 60.0
33-
- selector: google.longrunning.Operations.GetOperation
34-
deadline: 5.0
35-
3625
http:
3726
rules:
3827
- selector: google.cloud.location.Locations.GetLocation

0 commit comments

Comments
 (0)