Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 2095640

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: clarified some LRO types docs: fixed some wrong update mask descriptions (#298)
* docs: clarified some LRO types docs: fixed some wrong update mask descriptions PiperOrigin-RevId: 394033461 Source-Link: googleapis/googleapis@aa15f32 Source-Link: https://github.com/googleapis/googleapis-gen/commit/09f16b4e96c14341c51bb78fc39ff35bb4ab4766 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDlmMTZiNGU5NmMxNDM0MWM1MWJiNzhmYzM5ZmYzNWJiNGFiNDc2NiJ9 * 🦉 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 8215d4a commit 2095640

File tree

27 files changed

+5973
-233
lines changed

27 files changed

+5973
-233
lines changed

‎google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,13 @@ public final UnaryCallable<DeleteAgentRequest, Empty> deleteAgentCallable() {
672672

673673
// AUTO-GENERATED DOCUMENTATION AND METHOD.
674674
/**
675-
* Exports the specified agent to a binary file.
675+
* Exports the specified agent to a binary file. This method is a [long-running
676+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
677+
* returned `Operation` type has the following method-specific fields:
678+
*
679+
* <p>- `metadata`: An empty [Struct
680+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
681+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
676682
*
677683
* <p>Sample code:
678684
*
@@ -700,7 +706,13 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
700706

701707
// AUTO-GENERATED DOCUMENTATION AND METHOD.
702708
/**
703-
* Exports the specified agent to a binary file.
709+
* Exports the specified agent to a binary file. This method is a [long-running
710+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
711+
* returned `Operation` type has the following method-specific fields:
712+
*
713+
* <p>- `metadata`: An empty [Struct
714+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
715+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
704716
*
705717
* <p>Sample code:
706718
*
@@ -728,7 +740,13 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
728740

729741
// AUTO-GENERATED DOCUMENTATION AND METHOD.
730742
/**
731-
* Exports the specified agent to a binary file.
743+
* Exports the specified agent to a binary file. This method is a [long-running
744+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
745+
* returned `Operation` type has the following method-specific fields:
746+
*
747+
* <p>- `metadata`: An empty [Struct
748+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
749+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
732750
*
733751
* <p>Sample code:
734752
*

‎google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowsClient.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -617,8 +617,8 @@ public final UnaryCallable<GetFlowRequest, Flow> getFlowCallable() {
617617
* }</pre>
618618
*
619619
* @param flow Required. The flow to update.
620-
* @param updateMask Required. The mask to control which fields get updated. If `update_mask` is
621-
* not specified, an error will be returned.
620+
* @param updateMask The mask to control which fields get updated. If the mask is not present, all
621+
* fields will be updated.
622622
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
623623
*/
624624
public final Flow updateFlow(Flow flow, FieldMask updateMask) {

‎google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/TestCasesClient.java‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,12 @@ public final UnaryCallable<UpdateTestCaseRequest, TestCase> updateTestCaseCallab
677677

678678
// AUTO-GENERATED DOCUMENTATION AND METHOD.
679679
/**
680-
* Kicks off a test case run.
680+
* Kicks off a test case run. This method is a [long-running
681+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
682+
* returned `Operation` type has the following method-specific fields:
683+
*
684+
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
685+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
681686
*
682687
* <p>Sample code:
683688
*
@@ -705,7 +710,12 @@ public final OperationFuture<RunTestCaseResponse, RunTestCaseMetadata> runTestCa
705710

706711
// AUTO-GENERATED DOCUMENTATION AND METHOD.
707712
/**
708-
* Kicks off a test case run.
713+
* Kicks off a test case run. This method is a [long-running
714+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
715+
* returned `Operation` type has the following method-specific fields:
716+
*
717+
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
718+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
709719
*
710720
* <p>Sample code:
711721
*
@@ -733,7 +743,12 @@ public final OperationFuture<RunTestCaseResponse, RunTestCaseMetadata> runTestCa
733743

734744
// AUTO-GENERATED DOCUMENTATION AND METHOD.
735745
/**
736-
* Kicks off a test case run.
746+
* Kicks off a test case run. This method is a [long-running
747+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
748+
* returned `Operation` type has the following method-specific fields:
749+
*
750+
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
751+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
737752
*
738753
* <p>Sample code:
739754
*

‎google-cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/package-info.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
*/
1616

1717
/**
18-
* The interfaces provided are listed below, along with usage samples.
18+
* A client to Dialogflow API
19+
*
20+
* <p>The interfaces provided are listed below, along with usage samples.
1921
*
2022
* <p>======================= AgentsClient =======================
2123
*

‎grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -575,6 +575,12 @@ public void deleteAgent(
575575
*
576576
* <pre>
577577
* Exports the specified agent to a binary file.
578+
* This method is a [long-running
579+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
580+
* The returned `Operation` type has the following method-specific fields:
581+
* - `metadata`: An empty [Struct
582+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
583+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
578584
* </pre>
579585
*/
580586
public void exportAgent(
@@ -808,6 +814,12 @@ public void deleteAgent(
808814
*
809815
* <pre>
810816
* Exports the specified agent to a binary file.
817+
* This method is a [long-running
818+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
819+
* The returned `Operation` type has the following method-specific fields:
820+
* - `metadata`: An empty [Struct
821+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
822+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
811823
* </pre>
812824
*/
813825
public void exportAgent(
@@ -972,6 +984,12 @@ public com.google.protobuf.Empty deleteAgent(
972984
*
973985
* <pre>
974986
* Exports the specified agent to a binary file.
987+
* This method is a [long-running
988+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
989+
* The returned `Operation` type has the following method-specific fields:
990+
* - `metadata`: An empty [Struct
991+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
992+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
975993
* </pre>
976994
*/
977995
public com.google.longrunning.Operation exportAgent(
@@ -1126,6 +1144,12 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
11261144
*
11271145
* <pre>
11281146
* Exports the specified agent to a binary file.
1147+
* This method is a [long-running
1148+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1149+
* The returned `Operation` type has the following method-specific fields:
1150+
* - `metadata`: An empty [Struct
1151+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1152+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3beta1.ExportAgentResponse]
11291153
* </pre>
11301154
*/
11311155
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>

‎grpc-google-cloud-dialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/TestCasesGrpc.java‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -715,6 +715,11 @@ public void updateTestCase(
715715
*
716716
* <pre>
717717
* Kicks off a test case run.
718+
* This method is a [long-running
719+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
720+
* The returned `Operation` type has the following method-specific fields:
721+
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
722+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
718723
* </pre>
719724
*/
720725
public void runTestCase(
@@ -1009,6 +1014,11 @@ public void updateTestCase(
10091014
*
10101015
* <pre>
10111016
* Kicks off a test case run.
1017+
* This method is a [long-running
1018+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1019+
* The returned `Operation` type has the following method-specific fields:
1020+
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
1021+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
10121022
* </pre>
10131023
*/
10141024
public void runTestCase(
@@ -1215,6 +1225,11 @@ public com.google.cloud.dialogflow.cx.v3beta1.TestCase updateTestCase(
12151225
*
12161226
* <pre>
12171227
* Kicks off a test case run.
1228+
* This method is a [long-running
1229+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1230+
* The returned `Operation` type has the following method-specific fields:
1231+
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
1232+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
12181233
* </pre>
12191234
*/
12201235
public com.google.longrunning.Operation runTestCase(
@@ -1399,6 +1414,11 @@ protected TestCasesFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
13991414
*
14001415
* <pre>
14011416
* Kicks off a test case run.
1417+
* This method is a [long-running
1418+
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
1419+
* The returned `Operation` type has the following method-specific fields:
1420+
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3beta1.RunTestCaseMetadata]
1421+
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
14021422
* </pre>
14031423
*/
14041424
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>

0 commit comments

Comments
 (0)