docs: clarified some LRO types docs: fixed some wrong update mask des…

…criptions (#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>

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

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

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

@@ -19,6 +19,7 @@ package google.cloud.dialogflow.cx.v3beta1;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
 
 option cc_enable_arenas = true;

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

@@ -420,9 +420,9 @@ message UpdateFlowRequest {
  // Required. The flow to update.
  Flow flow = 1 [(google.api.field_behavior) = REQUIRED];
 
- // Required. The mask to control which fields get updated. If `update_mask` is not
- // specified, an error will be returned.
- google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+ // The mask to control which fields get updated. If the mask is not present,
+ // all fields will be updated.
+ google.protobuf.FieldMask update_mask = 2;
 
  // The language of the following fields in `flow`:
  //

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

@@ -94,6 +94,12 @@ service TestCases {
  }
 
  // Kicks off a test case run.
+ // This method is a [long-running
+ // operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+ // The returned `Operation` type has the following method-specific fields:
+ //
+ // - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
+ // - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
  rpc RunTestCase(RunTestCaseRequest) returns (google.longrunning.Operation) {
  option (google.api.http) = {
  post: "/v3beta1/{name=projects/*/locations/*/agents/*/testCases/*}:run"
@@ -284,7 +290,7 @@ message ConversationTurn {
 
  // Required. Input only. The diagnostic
  // [info][Session.DetectIntentResponse.QueryResult.diagnostic_info]
- // output for the turn.
+ // output for the turn. Required to calculate the testing coverage.
  google.protobuf.Struct diagnostic_info = 6 [
  (google.api.field_behavior) = REQUIRED,
  (google.api.field_behavior) = INPUT_ONLY
@@ -635,6 +641,7 @@ message RunTestCaseResponse {
 }
 
 // Metadata returned for the [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.RunTestCase] long running operation.
+// This message currently has no fields.
 message RunTestCaseMetadata {
 
 }

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

@@ -1053,6 +1053,13 @@ export class AgentsClient {
  ): void;
  /**
  * Exports the specified agent to a binary file.
+ * This method is a [long-running
+ * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+ * The returned `Operation` type has the following method-specific fields:
+ *
+ * - `metadata`: An empty [Struct
+ * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+ * - `response`: {@link google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse|ExportAgentResponse}
  *
  * @param {Object} request
  * The request object that will be sent.

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

@@ -803,8 +803,8 @@ export class FlowsClient {
  * @param {google.cloud.dialogflow.cx.v3beta1.Flow} request.flow
  * Required. The flow to update.
  * @param {google.protobuf.FieldMask} request.updateMask
- * Required. The mask to control which fields get updated. If `update_mask` is not
- * specified, an error will be returned.
+ * The mask to control which fields get updated. If the mask is not present,
+ * all fields will be updated.
  * @param {string} request.languageCode
  * The language of the following fields in `flow`:
  *

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

@@ -1090,6 +1090,12 @@ export class TestCasesClient {
  ): void;
  /**
  * Kicks off a test case run.
+ * This method is a [long-running
+ * operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
+ * The returned `Operation` type has the following method-specific fields:
+ *
+ * - `metadata`: {@link google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata|RunTestCaseMetadata}
+ * - `response`: {@link google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse|RunTestCaseResponse}
  *
  * @param {Object} request
  * The request object that will be sent.