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

Commit 84b863c

Browse files
yoshi-automationyoshi-automation
authored
docs: clarified some LRO types (#686)
PiperOrigin-RevId: 394302922 Source-Author: Google APIs <noreply@google.com> Source-Date: Wed Sep 1 13:32:34 2021 -0700 Source-Repo: googleapis/googleapis Source-Sha: cd16abbf04752a0d2d1ae1c4050a36ba725fedd1 Source-Link: googleapis/googleapis@cd16abb
1 parent 45bab02 commit 84b863c

File tree

16 files changed

+1260
-177
lines changed

16 files changed

+1260
-177
lines changed

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

Lines changed: 162 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -666,6 +666,15 @@ public final UnaryCallable<SearchAgentsRequest, SearchAgentsResponse> searchAgen
666666
/**
667667
* Trains the specified agent.
668668
*
669+
* <p>This method is a [long-running
670+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
671+
* returned `Operation` type has the following method-specific fields:
672+
*
673+
* <p>- `metadata`: An empty [Struct
674+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
675+
* - `response`: An [Empty
676+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
677+
*
669678
* <p>Note: You should always train an agent prior to sending it queries. See the [training
670679
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
671680
*
@@ -692,6 +701,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(LocationName parent)
692701
/**
693702
* Trains the specified agent.
694703
*
704+
* <p>This method is a [long-running
705+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
706+
* returned `Operation` type has the following method-specific fields:
707+
*
708+
* <p>- `metadata`: An empty [Struct
709+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
710+
* - `response`: An [Empty
711+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
712+
*
695713
* <p>Note: You should always train an agent prior to sending it queries. See the [training
696714
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
697715
*
@@ -718,6 +736,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(ProjectName parent)
718736
/**
719737
* Trains the specified agent.
720738
*
739+
* <p>This method is a [long-running
740+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
741+
* returned `Operation` type has the following method-specific fields:
742+
*
743+
* <p>- `metadata`: An empty [Struct
744+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
745+
* - `response`: An [Empty
746+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
747+
*
721748
* <p>Note: You should always train an agent prior to sending it queries. See the [training
722749
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
723750
*
@@ -743,6 +770,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(String parent) {
743770
/**
744771
* Trains the specified agent.
745772
*
773+
* <p>This method is a [long-running
774+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
775+
* returned `Operation` type has the following method-specific fields:
776+
*
777+
* <p>- `metadata`: An empty [Struct
778+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
779+
* - `response`: An [Empty
780+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
781+
*
746782
* <p>Note: You should always train an agent prior to sending it queries. See the [training
747783
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
748784
*
@@ -769,6 +805,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(TrainAgentRequest re
769805
/**
770806
* Trains the specified agent.
771807
*
808+
* <p>This method is a [long-running
809+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
810+
* returned `Operation` type has the following method-specific fields:
811+
*
812+
* <p>- `metadata`: An empty [Struct
813+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
814+
* - `response`: An [Empty
815+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
816+
*
772817
* <p>Note: You should always train an agent prior to sending it queries. See the [training
773818
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
774819
*
@@ -795,6 +840,15 @@ public final OperationCallable<TrainAgentRequest, Empty, Struct> trainAgentOpera
795840
/**
796841
* Trains the specified agent.
797842
*
843+
* <p>This method is a [long-running
844+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
845+
* returned `Operation` type has the following method-specific fields:
846+
*
847+
* <p>- `metadata`: An empty [Struct
848+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
849+
* - `response`: An [Empty
850+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
851+
*
798852
* <p>Note: You should always train an agent prior to sending it queries. See the [training
799853
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
800854
*
@@ -820,6 +874,14 @@ public final UnaryCallable<TrainAgentRequest, Operation> trainAgentCallable() {
820874
/**
821875
* Exports the specified agent to a ZIP file.
822876
*
877+
* <p>This method is a [long-running
878+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
879+
* returned `Operation` type has the following method-specific fields:
880+
*
881+
* <p>- `metadata`: An empty [Struct
882+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
883+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
884+
*
823885
* <p>Sample code:
824886
*
825887
* <pre>{@code
@@ -845,6 +907,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Locat
845907
/**
846908
* Exports the specified agent to a ZIP file.
847909
*
910+
* <p>This method is a [long-running
911+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
912+
* returned `Operation` type has the following method-specific fields:
913+
*
914+
* <p>- `metadata`: An empty [Struct
915+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
916+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
917+
*
848918
* <p>Sample code:
849919
*
850920
* <pre>{@code
@@ -870,6 +940,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Proje
870940
/**
871941
* Exports the specified agent to a ZIP file.
872942
*
943+
* <p>This method is a [long-running
944+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
945+
* returned `Operation` type has the following method-specific fields:
946+
*
947+
* <p>- `metadata`: An empty [Struct
948+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
949+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
950+
*
873951
* <p>Sample code:
874952
*
875953
* <pre>{@code
@@ -892,6 +970,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Strin
892970
/**
893971
* Exports the specified agent to a ZIP file.
894972
*
973+
* <p>This method is a [long-running
974+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
975+
* returned `Operation` type has the following method-specific fields:
976+
*
977+
* <p>- `metadata`: An empty [Struct
978+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
979+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
980+
*
895981
* <p>Sample code:
896982
*
897983
* <pre>{@code
@@ -917,6 +1003,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
9171003
/**
9181004
* Exports the specified agent to a ZIP file.
9191005
*
1006+
* <p>This method is a [long-running
1007+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1008+
* returned `Operation` type has the following method-specific fields:
1009+
*
1010+
* <p>- `metadata`: An empty [Struct
1011+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1012+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
1013+
*
9201014
* <p>Sample code:
9211015
*
9221016
* <pre>{@code
@@ -942,6 +1036,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
9421036
/**
9431037
* Exports the specified agent to a ZIP file.
9441038
*
1039+
* <p>This method is a [long-running
1040+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1041+
* returned `Operation` type has the following method-specific fields:
1042+
*
1043+
* <p>- `metadata`: An empty [Struct
1044+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1045+
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
1046+
*
9451047
* <p>Sample code:
9461048
*
9471049
* <pre>{@code
@@ -973,8 +1075,16 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()
9731075
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
9741076
* returns in order to train explicitly.
9751077
*
976-
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
977-
* updated not when it is done training.
1078+
* <p>This method is a [long-running
1079+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1080+
* returned `Operation` type has the following method-specific fields:
1081+
*
1082+
* <p>- `metadata`: An empty [Struct
1083+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1084+
* - `response`: An [Empty
1085+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1086+
*
1087+
* <p>The operation only tracks when importing is complete, not when it is done training.
9781088
*
9791089
* <p>Note: You should always train an agent prior to sending it queries. See the [training
9801090
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1010,8 +1120,16 @@ public final OperationFuture<Empty, Struct> importAgentAsync(ImportAgentRequest
10101120
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10111121
* returns in order to train explicitly.
10121122
*
1013-
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
1014-
* updated not when it is done training.
1123+
* <p>This method is a [long-running
1124+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1125+
* returned `Operation` type has the following method-specific fields:
1126+
*
1127+
* <p>- `metadata`: An empty [Struct
1128+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1129+
* - `response`: An [Empty
1130+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1131+
*
1132+
* <p>The operation only tracks when importing is complete, not when it is done training.
10151133
*
10161134
* <p>Note: You should always train an agent prior to sending it queries. See the [training
10171135
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1047,8 +1165,16 @@ public final OperationCallable<ImportAgentRequest, Empty, Struct> importAgentOpe
10471165
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10481166
* returns in order to train explicitly.
10491167
*
1050-
* <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
1051-
* updated not when it is done training.
1168+
* <p>This method is a [long-running
1169+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1170+
* returned `Operation` type has the following method-specific fields:
1171+
*
1172+
* <p>- `metadata`: An empty [Struct
1173+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1174+
* - `response`: An [Empty
1175+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1176+
*
1177+
* <p>The operation only tracks when importing is complete, not when it is done training.
10521178
*
10531179
* <p>Note: You should always train an agent prior to sending it queries. See the [training
10541180
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1082,8 +1208,16 @@ public final UnaryCallable<ImportAgentRequest, Operation> importAgentCallable()
10821208
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
10831209
* returns in order to train explicitly.
10841210
*
1085-
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1086-
* updated not when it is done training.
1211+
* <p>This method is a [long-running
1212+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1213+
* returned `Operation` type has the following method-specific fields:
1214+
*
1215+
* <p>- `metadata`: An empty [Struct
1216+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1217+
* - `response`: An [Empty
1218+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1219+
*
1220+
* <p>The operation only tracks when restoring is complete, not when it is done training.
10871221
*
10881222
* <p>Note: You should always train an agent prior to sending it queries. See the [training
10891223
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1118,8 +1252,16 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
11181252
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
11191253
* returns in order to train explicitly.
11201254
*
1121-
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1122-
* updated not when it is done training.
1255+
* <p>This method is a [long-running
1256+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1257+
* returned `Operation` type has the following method-specific fields:
1258+
*
1259+
* <p>- `metadata`: An empty [Struct
1260+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1261+
* - `response`: An [Empty
1262+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1263+
*
1264+
* <p>The operation only tracks when restoring is complete, not when it is done training.
11231265
*
11241266
* <p>Note: You should always train an agent prior to sending it queries. See the [training
11251267
* documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1155,8 +1297,16 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
11551297
* [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
11561298
* returns in order to train explicitly.
11571299
*
1158-
* <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
1159-
* updated not when it is done training.
1300+
* <p>This method is a [long-running
1301+
* operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
1302+
* returned `Operation` type has the following method-specific fields:
1303+
*
1304+
* <p>- `metadata`: An empty [Struct
1305+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
1306+
* - `response`: An [Empty
1307+
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
1308+
*
1309+
* <p>The operation only tracks when restoring is complete, not when it is done training.
11601310
*
11611311
* <p>Note: You should always train an agent prior to sending it queries. See the [training
11621312
* documentation](https://cloud.google.com/dialogflow/es/docs/training).

0 commit comments

Comments
 (0)