Skip to content

Commit cd16abb

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: clarified some LRO types
PiperOrigin-RevId: 394302922
1 parent b7537df commit cd16abb

6 files changed

Lines changed: 127 additions & 13 deletions

File tree

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,12 +94,15 @@ java_grpc_library(
9494
java_gapic_library(
9595
name = "dialogflow_java_gapic",
9696
srcs = [":dialogflow_proto_with_info"],
97+
gapic_yaml = None,
9798
grpc_service_config = "dialogflow_grpc_service_config.json",
99+
service_yaml = "dialogflow_v2.yaml",
98100
test_deps = [
99101
":dialogflow_java_grpc",
100102
],
101103
deps = [
102104
":dialogflow_java_proto",
105+
"//google/api:api_java_proto",
103106
],
104107
)
105108

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

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,14 @@ 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)
101109
//
102110
// Note: You should always train an agent prior to sending it queries. See the
103111
// [training
@@ -119,6 +127,14 @@ service Agents {
119127
}
120128

121129
// 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.v2.ExportAgentResponse]
122138
rpc ExportAgent(ExportAgentRequest) returns (google.longrunning.Operation) {
123139
option (google.api.http) = {
124140
post: "/v2/{parent=projects/*}/agent:export"
@@ -145,8 +161,17 @@ service Agents {
145161
// call [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it returns in order to train
146162
// explicitly.
147163
//
148-
// An operation which tracks when importing is complete. It only tracks
149-
// when the draft agent is updated not when it is done training.
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.
150175
//
151176
// Note: You should always train an agent prior to sending it queries. See the
152177
// [training
@@ -175,8 +200,17 @@ service Agents {
175200
// completed yet. Please call [TrainAgent][google.cloud.dialogflow.v2.Agents.TrainAgent] and wait for the operation it
176201
// returns in order to train explicitly.
177202
//
178-
// An operation which tracks when restoring is complete. It only tracks
179-
// when the draft agent is updated not when it is done training.
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.
180214
//
181215
// Note: You should always train an agent prior to sending it queries. See the
182216
// [training

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ package google.cloud.dialogflow.v2;
1919
import "google/api/field_behavior.proto";
2020
import "google/api/resource.proto";
2121
import "google/protobuf/duration.proto";
22+
import "google/protobuf/timestamp.proto";
2223
import "google/api/annotations.proto";
2324

2425
option cc_enable_arenas = true;

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

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,12 @@ service Documents {
7070

7171
// Creates a new document.
7272
//
73-
// Operation <response: [Document][google.cloud.dialogflow.v2.Document],
74-
// metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>
73+
// This method is a [long-running
74+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
75+
// The returned `Operation` type has the following method-specific fields:
76+
//
77+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
78+
// - `response`: [Document][google.cloud.dialogflow.v2.Document]
7579
rpc CreateDocument(CreateDocumentRequest) returns (google.longrunning.Operation) {
7680
option (google.api.http) = {
7781
post: "/v2/{parent=projects/*/knowledgeBases/*}/documents"
@@ -94,8 +98,13 @@ service Documents {
9498

9599
// Deletes the specified document.
96100
//
97-
// Operation <response: [google.protobuf.Empty][google.protobuf.Empty],
98-
// metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>
101+
// This method is a [long-running
102+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
103+
// The returned `Operation` type has the following method-specific fields:
104+
//
105+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
106+
// - `response`: An [Empty
107+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
99108
rpc DeleteDocument(DeleteDocumentRequest) returns (google.longrunning.Operation) {
100109
option (google.api.http) = {
101110
delete: "/v2/{name=projects/*/knowledgeBases/*/documents/*}"
@@ -115,8 +124,12 @@ service Documents {
115124

116125
// Updates the specified document.
117126
//
118-
// Operation <response: [Document][google.cloud.dialogflow.v2.Document],
119-
// metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>
127+
// This method is a [long-running
128+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
129+
// The returned `Operation` type has the following method-specific fields:
130+
//
131+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
132+
// - `response`: [Document][google.cloud.dialogflow.v2.Document]
120133
rpc UpdateDocument(UpdateDocumentRequest) returns (google.longrunning.Operation) {
121134
option (google.api.http) = {
122135
patch: "/v2/{document.name=projects/*/knowledgeBases/*/documents/*}"
@@ -142,11 +155,15 @@ service Documents {
142155
// Note: Even when the content of the document has not changed, there still
143156
// may be side effects because of internal implementation changes.
144157
//
158+
// This method is a [long-running
159+
// operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
160+
// The returned `Operation` type has the following method-specific fields:
161+
//
162+
// - `metadata`: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
163+
// - `response`: [Document][google.cloud.dialogflow.v2.Document]
164+
//
145165
// Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
146166
// only use `projects.knowledgeBases.documents`.
147-
//
148-
// Operation <response: [Document][google.cloud.dialogflow.v2.Document],
149-
// metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]>
150167
rpc ReloadDocument(ReloadDocumentRequest) returns (google.longrunning.Operation) {
151168
option (google.api.http) = {
152169
post: "/v2/{name=projects/*/knowledgeBases/*/documents/*}:reload"

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

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,13 @@ service EntityTypes {
116116

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

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

159175
// Creates multiple new entities in the specified entity type.
160176
//
177+
// This method is a [long-running
178+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
179+
// The returned `Operation` type has the following method-specific fields:
180+
//
181+
// - `metadata`: An empty [Struct
182+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
183+
// - `response`: An [Empty
184+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
185+
//
161186
// Note: You should always train an agent prior to sending it queries. See the
162187
// [training
163188
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
@@ -182,9 +207,19 @@ service EntityTypes {
182207
// method does not affect entities in the entity type that aren't explicitly
183208
// specified in the request.
184209
//
210+
// This method is a [long-running
211+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
212+
// The returned `Operation` type has the following method-specific fields:
213+
//
214+
// - `metadata`: An empty [Struct
215+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
216+
// - `response`: An [Empty
217+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
218+
//
185219
// Note: You should always train an agent prior to sending it queries. See the
186220
// [training
187221
// documentation](https://cloud.google.com/dialogflow/es/docs/training).
222+
//
188223
rpc BatchUpdateEntities(BatchUpdateEntitiesRequest) returns (google.longrunning.Operation) {
189224
option (google.api.http) = {
190225
post: "/v2/{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/v2/intent.proto‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,13 @@ service Intents {
126126

127127
// Updates/Creates multiple intents in the specified agent.
128128
//
129+
// This method is a [long-running
130+
// operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
131+
// The returned `Operation` type has the following method-specific fields:
132+
//
133+
// - `metadata`: An empty [Struct
134+
// message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
135+
// - `response`: [BatchUpdateIntentsResponse][google.cloud.dialogflow.v2.BatchUpdateIntentsResponse]
129136
//
130137
// Note: You should always train an agent prior to sending it queries. See the
131138
// [training
@@ -149,6 +156,14 @@ service Intents {
149156

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

0 commit comments

Comments
 (0)