Skip to content
This repository was archived by the owner on Jan 6, 2024. It is now read-only.

Commit a50e8dc

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: clarified LRO types (#156)
- [ ] 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
1 parent 8a7330f commit a50e8dc

12 files changed

Lines changed: 88 additions & 18 deletions

File tree

‎google/cloud/dialogflowcx_v3/services/agents/async_client.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -606,7 +606,16 @@ async def export_agent(
606606
timeout: float = None,
607607
metadata: Sequence[Tuple[str, str]] = (),
608608
) -> operation_async.AsyncOperation:
609-
r"""Exports the specified agent to a binary file.
609+
r"""Exports the specified agent to a binary file. This method is a
610+
`long-running
611+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
612+
The returned ``Operation`` type has the following
613+
method-specific fields:
614+
615+
- ``metadata``: An empty `Struct
616+
message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`__
617+
- ``response``:
618+
[ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
610619
611620
Args:
612621
request (:class:`google.cloud.dialogflowcx_v3.types.ExportAgentRequest`):

‎google/cloud/dialogflowcx_v3/services/agents/client.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,16 @@ def export_agent(
871871
timeout: float = None,
872872
metadata: Sequence[Tuple[str, str]] = (),
873873
) -> operation.Operation:
874-
r"""Exports the specified agent to a binary file.
874+
r"""Exports the specified agent to a binary file. This method is a
875+
`long-running
876+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
877+
The returned ``Operation`` type has the following
878+
method-specific fields:
879+
880+
- ``metadata``: An empty `Struct
881+
message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`__
882+
- ``response``:
883+
[ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
875884
876885
Args:
877886
request (google.cloud.dialogflowcx_v3.types.ExportAgentRequest):

‎google/cloud/dialogflowcx_v3/services/agents/transports/grpc.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -385,7 +385,16 @@ def export_agent(
385385
) -> Callable[[agent.ExportAgentRequest], operations_pb2.Operation]:
386386
r"""Return a callable for the export agent method over gRPC.
387387
388-
Exports the specified agent to a binary file.
388+
Exports the specified agent to a binary file. This method is a
389+
`long-running
390+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
391+
The returned ``Operation`` type has the following
392+
method-specific fields:
393+
394+
- ``metadata``: An empty `Struct
395+
message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`__
396+
- ``response``:
397+
[ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
389398
390399
Returns:
391400
Callable[[~.ExportAgentRequest],

‎google/cloud/dialogflowcx_v3/services/agents/transports/grpc_asyncio.py‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -392,7 +392,16 @@ def export_agent(
392392
) -> Callable[[agent.ExportAgentRequest], Awaitable[operations_pb2.Operation]]:
393393
r"""Return a callable for the export agent method over gRPC.
394394
395-
Exports the specified agent to a binary file.
395+
Exports the specified agent to a binary file. This method is a
396+
`long-running
397+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
398+
The returned ``Operation`` type has the following
399+
method-specific fields:
400+
401+
- ``metadata``: An empty `Struct
402+
message <https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct>`__
403+
- ``response``:
404+
[ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
396405
397406
Returns:
398407
Callable[[~.ExportAgentRequest],

‎google/cloud/dialogflowcx_v3/services/flows/async_client.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -540,9 +540,9 @@ async def update_flow(
540540
on the ``request`` instance; if ``request`` is provided, this
541541
should not be set.
542542
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
543-
Required. The mask to control which fields get updated.
544-
If ``update_mask`` is not specified, an error will be
545-
returned.
543+
The mask to control which fields get
544+
updated. If the mask is not present, all
545+
fields will be updated.
546546
547547
This corresponds to the ``update_mask`` field
548548
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/dialogflowcx_v3/services/flows/client.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -813,9 +813,9 @@ def update_flow(
813813
on the ``request`` instance; if ``request`` is provided, this
814814
should not be set.
815815
update_mask (google.protobuf.field_mask_pb2.FieldMask):
816-
Required. The mask to control which fields get updated.
817-
If ``update_mask`` is not specified, an error will be
818-
returned.
816+
The mask to control which fields get
817+
updated. If the mask is not present, all
818+
fields will be updated.
819819
820820
This corresponds to the ``update_mask`` field
821821
on the ``request`` instance; if ``request`` is provided, this

‎google/cloud/dialogflowcx_v3/services/test_cases/async_client.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,15 @@ async def run_test_case(
568568
timeout: float = None,
569569
metadata: Sequence[Tuple[str, str]] = (),
570570
) -> operation_async.AsyncOperation:
571-
r"""Kicks off a test case run.
571+
r"""Kicks off a test case run. This method is a `long-running
572+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
573+
The returned ``Operation`` type has the following
574+
method-specific fields:
575+
576+
- ``metadata``:
577+
[RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
578+
- ``response``:
579+
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
572580
573581
Args:
574582
request (:class:`google.cloud.dialogflowcx_v3.types.RunTestCaseRequest`):

‎google/cloud/dialogflowcx_v3/services/test_cases/client.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -899,7 +899,15 @@ def run_test_case(
899899
timeout: float = None,
900900
metadata: Sequence[Tuple[str, str]] = (),
901901
) -> operation.Operation:
902-
r"""Kicks off a test case run.
902+
r"""Kicks off a test case run. This method is a `long-running
903+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
904+
The returned ``Operation`` type has the following
905+
method-specific fields:
906+
907+
- ``metadata``:
908+
[RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
909+
- ``response``:
910+
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
903911
904912
Args:
905913
request (google.cloud.dialogflowcx_v3.types.RunTestCaseRequest):

‎google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -382,7 +382,15 @@ def run_test_case(
382382
) -> Callable[[test_case.RunTestCaseRequest], operations_pb2.Operation]:
383383
r"""Return a callable for the run test case method over gRPC.
384384
385-
Kicks off a test case run.
385+
Kicks off a test case run. This method is a `long-running
386+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
387+
The returned ``Operation`` type has the following
388+
method-specific fields:
389+
390+
- ``metadata``:
391+
[RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
392+
- ``response``:
393+
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
386394
387395
Returns:
388396
Callable[[~.RunTestCaseRequest],

‎google/cloud/dialogflowcx_v3/services/test_cases/transports/grpc_asyncio.py‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,15 @@ def run_test_case(
393393
) -> Callable[[test_case.RunTestCaseRequest], Awaitable[operations_pb2.Operation]]:
394394
r"""Return a callable for the run test case method over gRPC.
395395
396-
Kicks off a test case run.
396+
Kicks off a test case run. This method is a `long-running
397+
operation <https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation>`__.
398+
The returned ``Operation`` type has the following
399+
method-specific fields:
400+
401+
- ``metadata``:
402+
[RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
403+
- ``response``:
404+
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
397405
398406
Returns:
399407
Callable[[~.RunTestCaseRequest],

0 commit comments

Comments
 (0)