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

Commit

Permalink
docs: clarified some LRO types docs: fixed some wrong update mask des…
Browse files Browse the repository at this point in the history
…criptions (#296)

- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 393365899

Source-Link: googleapis/googleapis@4309574

Source-Link: https://github.com/googleapis/googleapis-gen/commit/4878f59e85c95457eb87a515f8bf739a2ec769cf
  • Loading branch information
gcf-owl-bot[bot] authored Sep 10, 2021
1 parent 6baa040 commit fcb3c26
Show file tree
Hide file tree
Showing 97 changed files with 6,178 additions and 364 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,13 @@ public final UnaryCallable<DeleteAgentRequest, Empty> deleteAgentCallable() {

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a binary file.
* Exports the specified agent to a binary file. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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.cx.v3.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -699,7 +705,13 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a binary file.
* Exports the specified agent to a binary file. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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.cx.v3.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -727,7 +739,13 @@ public final OperationFuture<ExportAgentResponse, Struct> exportAgentAsync(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports the specified agent to a binary file.
* Exports the specified agent to a binary file. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). 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.cx.v3.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -616,8 +616,8 @@ public final UnaryCallable<GetFlowRequest, Flow> getFlowCallable() {
* }</pre>
*
* @param flow Required. The flow to update.
* @param updateMask Required. The mask to control which fields get updated. If `update_mask` is
* not specified, an error will be returned.
* @param updateMask The mask to control which fields get updated. If the mask is not present, all
* fields will be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Flow updateFlow(Flow flow, FieldMask updateMask) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,12 @@ public final UnaryCallable<UpdateTestCaseRequest, TestCase> updateTestCaseCallab

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Kicks off a test case run.
* Kicks off a test case run. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata] -
* `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -703,7 +708,12 @@ public final OperationFuture<RunTestCaseResponse, RunTestCaseMetadata> runTestCa

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Kicks off a test case run.
* Kicks off a test case run. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata] -
* `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -731,7 +741,12 @@ public final OperationFuture<RunTestCaseResponse, RunTestCaseMetadata> runTestCa

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Kicks off a test case run.
* Kicks off a test case run. This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The
* returned `Operation` type has the following method-specific fields:
*
* <p>- `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata] -
* `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
*/

/**
* The interfaces provided are listed below, along with usage samples.
* A client to Dialogflow API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
* <p>======================= AgentsClient =======================
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,12 @@ public void deleteAgent(
*
* <pre>
* Exports the specified agent to a binary file.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
* </pre>
*/
public void exportAgent(
Expand Down Expand Up @@ -796,6 +802,12 @@ public void deleteAgent(
*
* <pre>
* Exports the specified agent to a binary file.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
* </pre>
*/
public void exportAgent(
Expand Down Expand Up @@ -960,6 +972,12 @@ public com.google.protobuf.Empty deleteAgent(
*
* <pre>
* Exports the specified agent to a binary file.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
* </pre>
*/
public com.google.longrunning.Operation exportAgent(
Expand Down Expand Up @@ -1114,6 +1132,12 @@ protected AgentsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions ca
*
* <pre>
* Exports the specified agent to a binary file.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: An empty [Struct
* message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
* - `response`: [ExportAgentResponse][google.cloud.dialogflow.cx.v3.ExportAgentResponse]
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -707,6 +707,11 @@ public void updateTestCase(
*
* <pre>
* Kicks off a test case run.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
* </pre>
*/
public void runTestCase(
Expand Down Expand Up @@ -993,6 +998,11 @@ public void updateTestCase(
*
* <pre>
* Kicks off a test case run.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
* </pre>
*/
public void runTestCase(
Expand Down Expand Up @@ -1197,6 +1207,11 @@ public com.google.cloud.dialogflow.cx.v3.TestCase updateTestCase(
*
* <pre>
* Kicks off a test case run.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
* </pre>
*/
public com.google.longrunning.Operation runTestCase(
Expand Down Expand Up @@ -1381,6 +1396,11 @@ protected TestCasesFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
*
* <pre>
* Kicks off a test case run.
* This method is a [long-running
* operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
* The returned `Operation` type has the following method-specific fields:
* - `metadata`: [RunTestCaseMetadata][google.cloud.dialogflow.cx.v3.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3.RunTestCaseResponse]
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand Down
Loading

0 comments on commit fcb3c26

Please sign in to comment.