docs: clarified LRO types (#156)

gcf-owl-bot[bot] · web-flow · commit a50e8dca8952 · 2021-08-27T20:36:34.000Z
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 393365899 Source-Link: googleapis/googleapis@4309574 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4878f59e85c95457eb87a515f8bf739a2ec769cf docs: fixed incorrect update mask descriptions
diff --git a/google/cloud/dialogflowcx_v3/services/agents/async_client.py b/google/cloud/dialogflowcx_v3/services/agents/async_client.py
@@ -606,7 +606,16 @@ async def export_agent(
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> operation_async.AsyncOperation:
-        r"""Exports the specified agent to a binary file.
+        r"""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.v3.ExportAgentResponse]
 
         Args:
             request (:class:`google.cloud.dialogflowcx_v3.types.ExportAgentRequest`):
diff --git a/google/cloud/dialogflowcx_v3/services/agents/client.py b/google/cloud/dialogflowcx_v3/services/agents/client.py
@@ -871,7 +871,16 @@ def export_agent(
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> operation.Operation:
-        r"""Exports the specified agent to a binary file.
+        r"""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.v3.ExportAgentResponse]
 
         Args:
             request (google.cloud.dialogflowcx_v3.types.ExportAgentRequest):
diff --git a/google/cloud/dialogflowcx_v3/services/agents/transports/grpc.py b/google/cloud/dialogflowcx_v3/services/agents/transports/grpc.py
@@ -385,7 +385,16 @@ def export_agent(
     ) -> Callable[[agent.ExportAgentRequest], operations_pb2.Operation]:
         r"""Return a callable for the export agent method over gRPC.
 
-        Exports the specified agent to a binary file.
+        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.v3.ExportAgentResponse]
 
         Returns:
             Callable[[~.ExportAgentRequest],
diff --git a/google/cloud/dialogflowcx_v3/services/agents/transports/grpc_asyncio.py b/google/cloud/dialogflowcx_v3/services/agents/transports/grpc_asyncio.py
@@ -392,7 +392,16 @@ def export_agent(
     ) -> Callable[[agent.ExportAgentRequest], Awaitable[operations_pb2.Operation]]:
         r"""Return a callable for the export agent method over gRPC.
 
-        Exports the specified agent to a binary file.
+        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.v3.ExportAgentResponse]
 
         Returns:
             Callable[[~.ExportAgentRequest],
diff --git a/google/cloud/dialogflowcx_v3/services/flows/async_client.py b/google/cloud/dialogflowcx_v3/services/flows/async_client.py
@@ -540,9 +540,9 @@ async def update_flow(
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
-                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.
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this
diff --git a/google/cloud/dialogflowcx_v3/services/flows/client.py b/google/cloud/dialogflowcx_v3/services/flows/client.py
@@ -813,9 +813,9 @@ def update_flow(
                 on the ``request`` instance; if ``request`` is provided, this
                 should not be set.
             update_mask (google.protobuf.field_mask_pb2.FieldMask):
-                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.
 
                 This corresponds to the ``update_mask`` field
                 on the ``request`` instance; if ``request`` is provided, this
diff --git a/google/cloud/dialogflowcx_v3/services/test_cases/async_client.py b/google/cloud/dialogflowcx_v3/services/test_cases/async_client.py
@@ -568,7 +568,15 @@ async def run_test_case(
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> operation_async.AsyncOperation:
-        r"""Kicks off a test case run.
+        r"""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.v3.RunTestCaseMetadata]
+        -  ``response``:
+           [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
 
         Args:
             request (:class:`google.cloud.dialogflowcx_v3.types.RunTestCaseRequest`):
diff --git a/google/cloud/dialogflowcx_v3/services/test_cases/client.py b/google/cloud/dialogflowcx_v3/services/test_cases/client.py
@@ -899,7 +899,15 @@ def run_test_case(
         timeout: float = None,
         metadata: Sequence[Tuple[str, str]] = (),
     ) -> operation.Operation:
-        r"""Kicks off a test case run.
+        r"""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.v3.RunTestCaseMetadata]
+        -  ``response``:
+           [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
 
         Args:
             request (google.cloud.dialogflowcx_v3.types.RunTestCaseRequest):
diff --git a/google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc.py b/google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc.py
@@ -382,7 +382,15 @@ def run_test_case(
     ) -> Callable[[test_case.RunTestCaseRequest], operations_pb2.Operation]:
         r"""Return a callable for the run test case method over gRPC.
 
-        Kicks off a test case run.
+        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.v3.RunTestCaseMetadata]
+        -  ``response``:
+           [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
 
         Returns:
             Callable[[~.RunTestCaseRequest],
diff --git a/google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc_asyncio.py b/google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc_asyncio.py
@@ -393,7 +393,15 @@ def run_test_case(
     ) -> Callable[[test_case.RunTestCaseRequest], Awaitable[operations_pb2.Operation]]:
         r"""Return a callable for the run test case method over gRPC.
 
-        Kicks off a test case run.
+        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.v3.RunTestCaseMetadata]
+        -  ``response``:
+           [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
 
         Returns:
             Callable[[~.RunTestCaseRequest],
diff --git a/google/cloud/dialogflowcx_v3/types/flow.py b/google/cloud/dialogflowcx_v3/types/flow.py
@@ -322,8 +322,9 @@ class UpdateFlowRequest(proto.Message):
         flow (google.cloud.dialogflowcx_v3.types.Flow):
             Required. The flow to update.
         update_mask (google.protobuf.field_mask_pb2.FieldMask):
-            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.
         language_code (str):
             The language of the following fields in ``flow``:
 
diff --git a/google/cloud/dialogflowcx_v3/types/test_case.py b/google/cloud/dialogflowcx_v3/types/test_case.py
@@ -223,7 +223,8 @@ class VirtualAgentOutput(proto.Message):
             diagnostic_info (google.protobuf.struct_pb2.Struct):
                 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.
             triggered_intent (google.cloud.dialogflowcx_v3.types.Intent):
                 The [Intent][google.cloud.dialogflow.cx.v3.Intent] that
                 triggered the response. Only name and displayName will be
@@ -664,7 +665,7 @@ class RunTestCaseResponse(proto.Message):
 class RunTestCaseMetadata(proto.Message):
     r"""Metadata returned for the
     [TestCases.RunTestCase][google.cloud.dialogflow.cx.v3.TestCases.RunTestCase]
-    long running operation.
+    long running operation. This message currently has no fields.
         """
 
 
