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
googleapis · Sep 3, 2021 · 84b863c · 84b863c
1 parent 45bab02
commit 84b863c
Show file tree

Hide file tree

Showing 16 changed files with 1,260 additions and 177 deletions.
diff --git a/google-cloud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2/AgentsClient.java b/google-cloud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2/AgentsClient.java
@@ -666,6 +666,15 @@ public final UnaryCallable<SearchAgentsRequest, SearchAgentsResponse> searchAgen
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -692,6 +701,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(LocationName parent)
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -718,6 +736,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(ProjectName parent)
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -743,6 +770,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(String parent) {
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -769,6 +805,15 @@ public final OperationFuture<Empty, Struct> trainAgentAsync(TrainAgentRequest re
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -795,6 +840,15 @@ public final OperationCallable<TrainAgentRequest, Empty, Struct> trainAgentOpera
   /**
    * Trains the specified agent.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
    *
@@ -820,6 +874,14 @@ public final UnaryCallable<TrainAgentRequest, Operation> trainAgentCallable() {
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -845,6 +907,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Locat
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -870,6 +940,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Proje
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -892,6 +970,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(Strin
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -917,6 +1003,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -942,6 +1036,14 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(
   /**
    * Exports the specified agent to a ZIP file.
    *
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2.ExportAgentResponse]
+   *
    * <p>Sample code:
    *
    * <pre>{@code
@@ -973,8 +1075,16 @@ public final UnaryCallable<ExportAgentRequest, Operation> exportAgentCallable()
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when importing is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1010,8 +1120,16 @@ public final OperationFuture<Empty, Struct> importAgentAsync(ImportAgentRequest
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when importing is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1047,8 +1165,16 @@ public final OperationCallable<ImportAgentRequest, Empty, Struct> importAgentOpe
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when importing is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when importing is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1082,8 +1208,16 @@ public final UnaryCallable<ImportAgentRequest, Operation> importAgentCallable()
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when restoring is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1118,8 +1252,16 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when restoring is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -1155,8 +1297,16 @@ public final OperationFuture<Empty, Struct> restoreAgentAsync(RestoreAgentReques
    * [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
    * returns in order to train explicitly.
    *
-   * <p>An operation which tracks when restoring is complete. It only tracks when the draft agent is
-   * updated not when it is done training.
+   * <p>This method is a [long-running
+   * operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations). The
+   * returned `Operation` type has the following method-specific fields:
+   *
+   * <p>- `metadata`: An empty [Struct
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
+   * - `response`: An [Empty
+   * message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
+   *
+   * <p>The operation only tracks when restoring is complete, not when it is done training.
    *
    * <p>Note: You should always train an agent prior to sending it queries. See the [training
    * documentation](https://cloud.google.com/dialogflow/es/docs/training).