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

docs: clarified some LRO types docs: fixed some wrong update mask descriptions #298

Merged
merged 2 commits into from
Sep 13, 2021
Merged

docs: clarified some LRO types docs: fixed some wrong update mask descriptions #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d280e54
docs: clarified some LRO types docs: fixed some wrong update mask des…
gcf-owl-bot[bot] Sep 10, 2021
1fd9665
🦉 Updates from OwlBot
gcf-owl-bot[bot] Sep 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 21 additions & 3 deletions ...loud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
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
4 changes: 2 additions & 2 deletions ...cloud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/FlowsClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
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
21 changes: 18 additions & 3 deletions ...d-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/TestCasesClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
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
4 changes: 3 additions & 1 deletion ...loud-dialogflow-cx/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/package-info.java
View file
Open in desktop
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
24 changes: 24 additions & 0 deletions ...ialogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/AgentsGrpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
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
20 changes: 20 additions & 0 deletions ...ogflow-cx-v3beta1/src/main/java/com/google/cloud/dialogflow/cx/v3beta1/TestCasesGrpc.java
View file
Open in desktop
Original file line number Diff line number Diff line change
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
Loading