Skip to content

Commit 3d4f15a

Browse files
docs: clarified some LRO types docs: fixed some wrong update mask descriptions (#173)
* docs: clarified some LRO types docs: fixed some wrong update mask descriptions PiperOrigin-RevId: 394033461 Source-Link: googleapis/googleapis@aa15f32 Source-Link: googleapis/googleapis-gen@09f16b4 * 🦉 Updates from OwlBot See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent e2b5897 commit 3d4f15a

File tree

8 files changed

+35
-10
lines changed

8 files changed

+35
-10
lines changed

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/agent.proto

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,13 @@ service Agents {
9494
}
9595

9696
// Exports the specified agent to a binary file.
97+
// This method is a [long-running
98+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
99+
// The returned `Operation` type has the following method-specific fields:
100+
//
101+
// - `metadata`: An empty [Struct
102+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
103+
// - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
97104
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
98105
option (google.api.http) = {
99106
post: "/v3beta1/{name=projects/*/locations/*/agents/*}:export"

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/audio_config.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3beta1;
1919
import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
2121
import "google/protobuf/duration.proto";
22+
import "google/protobuf/timestamp.proto";
2223
import "google/api/annotations.proto";
2324

2425
option cc_enable_arenas = true;

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/flow.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -420,9 +420,9 @@ message UpdateFlowRequest {
420420
// Required. The flow to update.
421421
Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
422422

423-
// Required. The mask to control which fields get updated. If `update_mask` is not
424-
// specified, an error will be returned.
425-
google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
423+
// The mask to control which fields get updated. If the mask is not present,
424+
// all fields will be updated.
425+
google.protobuf.FieldMask update_mask = 2;
426426

427427
// The language of the following fields in `flow`:
428428
//

packages/google-cloud-dialogflow-cx/protos/google/cloud/dialogflow/cx/v3beta1/test_case.proto

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,12 @@ service TestCases {
9494
}
9595

9696
// Kicks off a test case run.
97+
// This method is a [long-running
98+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
99+
// The returned `Operation` type has the following method-specific fields:
100+
//
101+
// - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
102+
// - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
97103
rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
98104
option (google.api.http) = {
99105
post: "/v3beta1/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@@ -284,7 +290,7 @@ message ConversationTurn {
284290

285291
// Required. Input only. The diagnostic
286292
// [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
287-
// output for the turn.
293+
// output for the turn. Required to calculate the testing coverage.
288294
google.protobuf.Struct diagnostic_info = 6 [
289295
(google.api.field_behavior) = REQUIRED,
290296
(google.api.field_behavior) = INPUT_ONLY
@@ -635,6 +641,7 @@ message RunTestCaseResponse {
635641
}
636642

637643
// Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.RunTestCase] long running operation.
644+
// This message currently has no fields.
638645
message RunTestCaseMetadata {
639646

640647
}

packages/google-cloud-dialogflow-cx/protos/protos.json

Lines changed: 1 addition & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/google-cloud-dialogflow-cx/src/v3beta1/agents_client.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1053,6 +1053,13 @@ export class AgentsClient {
10531053
): void;
10541054
/**
10551055
* Exports the specified agent to a binary file.
1056+
* This method is a [long-running
1057+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1058+
* The returned `Operation` type has the following method-specific fields:
1059+
*
1060+
* - `metadata`: An empty [Struct
1061+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1062+
* - `response`: {@link google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse|ExportAgentResponse}
10561063
*
10571064
* @param {Object} request
10581065
* The request object that will be sent.

packages/google-cloud-dialogflow-cx/src/v3beta1/flows_client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -803,8 +803,8 @@ export class FlowsClient {
803803
* @param {google.cloud.dialogflow.cx.v3beta1.Flow} request.flow
804804
* Required. The flow to update.
805805
* @param {google.protobuf.FieldMask} request.updateMask
806-
* Required. The mask to control which fields get updated. If `update_mask` is not
807-
* specified, an error will be returned.
806+
* The mask to control which fields get updated. If the mask is not present,
807+
* all fields will be updated.
808808
* @param {string} request.languageCode
809809
* The language of the following fields in `flow`:
810810
*

packages/google-cloud-dialogflow-cx/src/v3beta1/test_cases_client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1090,6 +1090,12 @@ export class TestCasesClient {
10901090
): void;
10911091
/**
10921092
* Kicks off a test case run.
1093+
* This method is a [long-running
1094+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1095+
* The returned `Operation` type has the following method-specific fields:
1096+
*
1097+
* - `metadata`: {@link google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata|RunTestCaseMetadata}
1098+
* - `response`: {@link google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse|RunTestCaseResponse}
10931099
*
10941100
* @param {Object} request
10951101
* The request object that will be sent.

0 commit comments

Comments
 (0)