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 (#298)

* docs: clarified some LRO types docs: fixed some wrong update mask descriptions

PiperOrigin-RevId: 394033461

Source-Link: googleapis/googleapis@aa15f32

Source-Link: googleapis/googleapis-gen@09f16b4
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDlmMTZiNGU5NmMxNDM0MWM1MWJiNzhmYzM5ZmYzNWJiNGFiNDc2NiJ9

* 🦉 Updates from OwlBot

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] committed Sep 13, 2021
1 parent 8215d4a commit 2095640
Show file tree
Hide file tree
Showing 27 changed files with 5,973 additions and 233 deletions.
Expand Up @@ -672,7 +672,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.v3beta1.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -700,7 +706,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.v3beta1.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -728,7 +740,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.v3beta1.ExportAgentResponse]
*
* <p>Sample code:
*
Expand Down
Expand Up @@ -617,8 +617,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
Expand Up @@ -677,7 +677,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -705,7 +710,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down Expand Up @@ -733,7 +743,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
*
* <p>Sample code:
*
Expand Down
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
Expand Up @@ -575,6 +575,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.v3beta1.ExportAgentResponse]
* </pre>
*/
public void exportAgent(
Expand Down Expand Up @@ -808,6 +814,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.v3beta1.ExportAgentResponse]
* </pre>
*/
public void exportAgent(
Expand Down Expand Up @@ -972,6 +984,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.v3beta1.ExportAgentResponse]
* </pre>
*/
public com.google.longrunning.Operation exportAgent(
Expand Down Expand Up @@ -1126,6 +1144,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.v3beta1.ExportAgentResponse]
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand Down
Expand Up @@ -715,6 +715,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
* </pre>
*/
public void runTestCase(
Expand Down Expand Up @@ -1009,6 +1014,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
* </pre>
*/
public void runTestCase(
Expand Down Expand Up @@ -1215,6 +1225,11 @@ public com.google.cloud.dialogflow.cx.v3beta1.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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
* </pre>
*/
public com.google.longrunning.Operation runTestCase(
Expand Down Expand Up @@ -1399,6 +1414,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.v3beta1.RunTestCaseMetadata]
* - `response`: [RunTestCaseResponse][google.cloud.dialogflow.cx.v3beta1.RunTestCaseResponse]
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>
Expand Down

0 comments on commit 2095640

Please sign in to comment.