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

docs(v3beta1): clarified LRO types #161

Merged
merged 2 commits into from Aug 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -608,7 +608,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.v3beta1.ExportAgentResponse]

Args:
request (:class:`google.cloud.dialogflowcx_v3beta1.types.ExportAgentRequest`):
Expand Down
11 changes: 10 additions & 1 deletion google/cloud/dialogflowcx_v3beta1/services/agents/client.py
Expand Up @@ -873,7 +873,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.v3beta1.ExportAgentResponse]

Args:
request (google.cloud.dialogflowcx_v3beta1.types.ExportAgentRequest):
Expand Down
Expand Up @@ -386,7 +386,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.v3beta1.ExportAgentResponse]

Returns:
Callable[[~.ExportAgentRequest],
Expand Down
Expand Up @@ -393,7 +393,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.v3beta1.ExportAgentResponse]

Returns:
Callable[[~.ExportAgentRequest],
Expand Down
Expand Up @@ -542,9 +542,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
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/dialogflowcx_v3beta1/services/flows/client.py
Expand Up @@ -815,9 +815,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
Expand Down
Expand Up @@ -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.v3beta1.RunTestCaseMetadata]
- ``response``:
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]

Args:
request (:class:`google.cloud.dialogflowcx_v3beta1.types.RunTestCaseRequest`):
Expand Down
10 changes: 9 additions & 1 deletion google/cloud/dialogflowcx_v3beta1/services/test_cases/client.py
Expand Up @@ -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.v3beta1.RunTestCaseMetadata]
- ``response``:
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]

Args:
request (google.cloud.dialogflowcx_v3beta1.types.RunTestCaseRequest):
Expand Down
Expand Up @@ -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.v3beta1.RunTestCaseMetadata]
- ``response``:
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]

Returns:
Callable[[~.RunTestCaseRequest],
Expand Down
Expand Up @@ -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.v3beta1.RunTestCaseMetadata]
- ``response``:
[RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]

Returns:
Callable[[~.RunTestCaseRequest],
Expand Down
5 changes: 3 additions & 2 deletions google/cloud/dialogflowcx_v3beta1/types/flow.py
Expand Up @@ -322,8 +322,9 @@ class UpdateFlowRequest(proto.Message):
flow (google.cloud.dialogflowcx_v3beta1.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``:

Expand Down
5 changes: 3 additions & 2 deletions google/cloud/dialogflowcx_v3beta1/types/test_case.py
Expand Up @@ -224,7 +224,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_v3beta1.types.Intent):
The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that
triggered the response. Only name and displayName will be
Expand Down Expand Up @@ -666,7 +667,7 @@ class RunTestCaseResponse(proto.Message):
class RunTestCaseMetadata(proto.Message):
r"""Metadata returned for the
[TestCases.RunTestCase][google.cloud.dialogflow.cx.v3beta1.TestCases.RunTestCase]
long running operation.
long running operation. This message currently has no fields.
"""


Expand Down