Skip to content

Commit e3c419f

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: clarified some LRO types
PiperOrigin-RevId: 394490143
1 parent 52c8913 commit e3c419f

6 files changed

Lines changed: 141 additions & 0 deletions

File tree

‎google/cloud/dialogflow/v2beta1/BUILD.bazel‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,11 +95,13 @@ java_gapic_library(
9595
name = "dialogflow_java_gapic",
9696
srcs = [":dialogflow_proto_with_info"],
9797
grpc_service_config = "dialogflow_grpc_service_config.json",
98+
service_yaml = "dialogflow_v2beta1.yaml",
9899
test_deps = [
99100
":dialogflow_java_grpc",
100101
],
101102
deps = [
102103
":dialogflow_java_proto",
104+
"//google/api:api_java_proto",
103105
],
104106
)
105107

‎google/cloud/dialogflow/v2beta1/agent.proto‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,15 @@ service Agents {
9898

9999
// Trains the specified agent.
100100
//
101+
// This method is a [long-running
102+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
103+
// The returned `Operation` type has the following method-specific fields:
104+
//
105+
// - `metadata`: An empty [Struct
106+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
107+
// - `response`: An [Empty
108+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
109+
//
101110
// Note: You should always train an agent prior to sending it queries. See the
102111
// [training
103112
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -118,6 +127,14 @@ service Agents {
118127
}
119128

120129
// Exports the specified agent to a ZIP file.
130+
//
131+
// This method is a [long-running
132+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
133+
// The returned `Operation` type has the following method-specific fields:
134+
//
135+
// - `metadata`: An empty [Struct
136+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
137+
// - `response`: [ExportAgentResponse][google.cloud.dialogflow.v2beta1.ExportAgentResponse]
121138
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
122139
option (google.api.http) = {
123140
post: "/v2beta1/{parent=projects/*}/agent:export"
@@ -144,6 +161,18 @@ service Agents {
144161
// call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it returns in order to train
145162
// explicitly.
146163
//
164+
// This method is a [long-running
165+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
166+
// The returned `Operation` type has the following method-specific fields:
167+
//
168+
// - `metadata`: An empty [Struct
169+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
170+
// - `response`: An [Empty
171+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
172+
//
173+
// The operation only tracks when importing is complete, not when it is done
174+
// training.
175+
//
147176
// Note: You should always train an agent prior to sending it queries. See the
148177
// [training
149178
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -171,6 +200,18 @@ service Agents {
171200
// completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2beta1.Agents.TrainAgent] and wait for the operation it
172201
// returns in order to train explicitly.
173202
//
203+
// This method is a [long-running
204+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
205+
// The returned `Operation` type has the following method-specific fields:
206+
//
207+
// - `metadata`: An empty [Struct
208+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
209+
// - `response`: An [Empty
210+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
211+
//
212+
// The operation only tracks when restoring is complete, not when it is done
213+
// training.
214+
//
174215
// Note: You should always train an agent prior to sending it queries. See the
175216
// [training
176217
// documentation](https://cloud.google.com/dialogflow/es/docs/training).

‎google/cloud/dialogflow/v2beta1/audio_config.proto‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
2121
import "google/protobuf/duration.proto";
2222
import "google/protobuf/field_mask.proto";
23+
import "google/protobuf/timestamp.proto";
2324
import "google/api/annotations.proto";
2425

2526
option cc_enable_arenas = true;

‎google/cloud/dialogflow/v2beta1/document.proto‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,13 @@ service Documents {
7878

7979
// Creates a new document.
8080
//
81+
// This method is a [long-running
82+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
83+
// The returned `Operation` type has the following method-specific fields:
84+
//
85+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]
86+
// - `response`: [Document][google.cloud.dialogflow.v2beta1.Document]
87+
//
8188
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
8289
// only use `projects.knowledgeBases.documents`.
8390
rpc CreateDocument(CreateDocumentRequest) returns (google.longrunning.Operation) {
@@ -103,6 +110,13 @@ service Documents {
103110
// Create documents by importing data from external sources.
104111
// Dialogflow supports up to 350 documents in each request. If you try to
105112
// import more, Dialogflow will return an error.
113+
//
114+
// This method is a [long-running
115+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
116+
// The returned `Operation` type has the following method-specific fields:
117+
//
118+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]
119+
// - `response`: [ImportDocumentsResponse][google.cloud.dialogflow.v2beta1.ImportDocumentsResponse]
106120
rpc ImportDocuments(ImportDocumentsRequest) returns (google.longrunning.Operation) {
107121
option (google.api.http) = {
108122
post: "/v2beta1/{parent=projects/*/knowledgeBases/*}/documents:import"
@@ -120,6 +134,14 @@ service Documents {
120134

121135
// Deletes the specified document.
122136
//
137+
// This method is a [long-running
138+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
139+
// The returned `Operation` type has the following method-specific fields:
140+
//
141+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]
142+
// - `response`: An [Empty
143+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
144+
//
123145
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
124146
// only use `projects.knowledgeBases.documents`.
125147
rpc DeleteDocument(DeleteDocumentRequest) returns (google.longrunning.Operation) {
@@ -141,6 +163,13 @@ service Documents {
141163

142164
// Updates the specified document.
143165
//
166+
// This method is a [long-running
167+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
168+
// The returned `Operation` type has the following method-specific fields:
169+
//
170+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]
171+
// - `response`: [Document][google.cloud.dialogflow.v2beta1.Document]
172+
//
144173
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
145174
// only use `projects.knowledgeBases.documents`.
146175
rpc UpdateDocument(UpdateDocumentRequest) returns (google.longrunning.Operation) {
@@ -172,6 +201,13 @@ service Documents {
172201
// be replaced with the custom metadata from Google Cloud Storage if the
173202
// `import_gcs_custom_metadata` field is set to true in the request.
174203
//
204+
// This method is a [long-running
205+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
206+
// The returned `Operation` type has the following method-specific fields:
207+
//
208+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2beta1.KnowledgeOperationMetadata]
209+
// - `response`: [Document][google.cloud.dialogflow.v2beta1.Document]
210+
//
175211
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
176212
// only use `projects.knowledgeBases.documents`.
177213
rpc ReloadDocument(ReloadDocumentRequest) returns (google.longrunning.Operation) {

‎google/cloud/dialogflow/v2beta1/entity_type.proto‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,14 @@ service EntityTypes {
117117

118118
// Updates/Creates multiple entity types in the specified agent.
119119
//
120+
// This method is a [long-running
121+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
122+
// The returned `Operation` type has the following method-specific fields:
123+
//
124+
// - `metadata`: An empty [Struct
125+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
126+
// - `response`: [BatchUpdateEntityTypesResponse][google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse]
127+
//
120128
// Note: You should always train an agent prior to sending it queries. See the
121129
// [training
122130
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -137,6 +145,15 @@ service EntityTypes {
137145

138146
// Deletes entity types in the specified agent.
139147
//
148+
// This method is a [long-running
149+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
150+
// The returned `Operation` type has the following method-specific fields:
151+
//
152+
// - `metadata`: An empty [Struct
153+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
154+
// - `response`: An [Empty
155+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
156+
//
140157
// Note: You should always train an agent prior to sending it queries. See the
141158
// [training
142159
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -158,6 +175,15 @@ service EntityTypes {
158175

159176
// Creates multiple new entities in the specified entity type.
160177
//
178+
// This method is a [long-running
179+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
180+
// The returned `Operation` type has the following method-specific fields:
181+
//
182+
// - `metadata`: An empty [Struct
183+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
184+
// - `response`: An [Empty
185+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
186+
//
161187
// Note: You should always train an agent prior to sending it queries. See the
162188
// [training
163189
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -185,6 +211,15 @@ service EntityTypes {
185211
// Note: You should always train an agent prior to sending it queries. See the
186212
// [training
187213
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
214+
//
215+
// This method is a [long-running
216+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
217+
// The returned `Operation` type has the following method-specific fields:
218+
//
219+
// - `metadata`: An empty [Struct
220+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
221+
// - `response`: An [Empty
222+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
188223
rpc BatchUpdateEntities(BatchUpdateEntitiesRequest) returns (google.longrunning.Operation) {
189224
option (google.api.http) = {
190225
post: "/v2beta1/{parent=projects/*/agent/entityTypes/*}/entities:batchUpdate"
@@ -204,6 +239,15 @@ service EntityTypes {
204239

205240
// Deletes entities in the specified entity type.
206241
//
242+
// This method is a [long-running
243+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
244+
// The returned `Operation` type has the following method-specific fields:
245+
//
246+
// - `metadata`: An empty [Struct
247+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
248+
// - `response`: An [Empty
249+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
250+
//
207251
// Note: You should always train an agent prior to sending it queries. See the
208252
// [training
209253
// documentation](https://cloud.google.com/dialogflow/es/docs/training).

‎google/cloud/dialogflow/v2beta1/intent.proto‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,14 @@ service Intents {
128128

129129
// Updates/Creates multiple intents in the specified agent.
130130
//
131+
// This method is a [long-running
132+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
133+
// The returned `Operation` type has the following method-specific fields:
134+
//
135+
// - `metadata`: An empty [Struct
136+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
137+
// - `response`: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2beta1.BatchUpdateIntentsResponse]
138+
//
131139
// Note: You should always train an agent prior to sending it queries. See the
132140
// [training
133141
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -150,6 +158,15 @@ service Intents {
150158

151159
// Deletes intents in the specified agent.
152160
//
161+
// This method is a [long-running
162+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
163+
// The returned `Operation` type has the following method-specific fields:
164+
//
165+
// - `metadata`: An empty [Struct
166+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
167+
// - `response`: An [Empty
168+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
169+
//
153170
// Note: You should always train an agent prior to sending it queries. See the
154171
// [training
155172
// documentation](https://cloud.google.com/dialogflow/es/docs/training).

0 commit comments

Comments
 (0)