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

Commit

Permalink
feat: added support for custom content types docs: reformat comments (#…
Browse files Browse the repository at this point in the history
…375)

* feat: added support for custom content types docs: reformat comments

PiperOrigin-RevId: 414026488

Source-Link: googleapis/googleapis@26ab5dd

Source-Link: https://github.com/googleapis/googleapis-gen/commit/d4c1a646b4056e598eba01213af350bd8f6a6952
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDRjMWE2NDZiNDA1NmU1OThlYmEwMTIxM2FmMzUwYmQ4ZjZhNjk1MiJ9

* 🦉 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] authored Dec 7, 2021
1 parent 5726848 commit b1affa6
Show file tree
Hide file tree
Showing 52 changed files with 3,383 additions and 2,127 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ public final OperationsClient getOperationsClient() {
* }</pre>
*
* @param parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions
* for. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;`.
* for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListVersionsPagedResponse listVersions(FlowName parent) {
Expand All @@ -207,8 +207,8 @@ public final ListVersionsPagedResponse listVersions(FlowName parent) {
* }</pre>
*
* @param parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to list all versions
* for. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;`.
* for. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListVersionsPagedResponse listVersions(String parent) {
Expand Down Expand Up @@ -318,7 +318,8 @@ public final UnaryCallable<ListVersionsRequest, ListVersionsResponse> listVersio
* }</pre>
*
* @param name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Version getVersion(VersionName name) {
Expand All @@ -342,7 +343,8 @@ public final Version getVersion(VersionName name) {
* }</pre>
*
* @param name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version]. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Version getVersion(String name) {
Expand Down Expand Up @@ -423,8 +425,8 @@ public final UnaryCallable<GetVersionRequest, Version> getVersionCallable() {
* }</pre>
*
* @param parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an
* [Version][google.cloud.dialogflow.cx.v3.Version] for. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;`.
* [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: `projects/&lt;Project
* ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
* @param version Required. The version to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -462,8 +464,8 @@ public final OperationFuture<Version, CreateVersionOperationMetadata> createVers
* }</pre>
*
* @param parent Required. The [Flow][google.cloud.dialogflow.cx.v3.Flow] to create an
* [Version][google.cloud.dialogflow.cx.v3.Version] for. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;`.
* [Version][google.cloud.dialogflow.cx.v3.Version] for. Format: `projects/&lt;Project
* ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;`.
* @param version Required. The version to create.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
Expand Down Expand Up @@ -661,8 +663,8 @@ public final UnaryCallable<UpdateVersionRequest, Version> updateVersionCallable(
* }</pre>
*
* @param name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to
* delete. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteVersion(VersionName name) {
Expand All @@ -686,8 +688,8 @@ public final void deleteVersion(VersionName name) {
* }</pre>
*
* @param name Required. The name of the [Version][google.cloud.dialogflow.cx.v3.Version] to
* delete. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* delete. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/&lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final void deleteVersion(String name) {
Expand Down Expand Up @@ -768,8 +770,8 @@ public final UnaryCallable<DeleteVersionRequest, Empty> deleteVersionCallable()
* }</pre>
*
* @param name Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to
* draft flow. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* draft flow. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location
* ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, Struct> loadVersionAsync(VersionName name) {
Expand Down Expand Up @@ -802,8 +804,8 @@ public final OperationFuture<Empty, Struct> loadVersionAsync(VersionName name) {
* }</pre>
*
* @param name Required. The [Version][google.cloud.dialogflow.cx.v3.Version] to be loaded to
* draft flow. Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* draft flow. Format: `projects/&lt;Project ID&gt;/locations/&lt;Location
* ID&gt;/agents/&lt;Agent ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Empty, Struct> loadVersionAsync(String name) {
Expand Down Expand Up @@ -931,8 +933,8 @@ public final UnaryCallable<LoadVersionRequest, Operation> loadVersionCallable()
*
* @param baseVersion Required. Name of the base flow version to compare with the target version.
* Use version ID `0` to indicate the draft version of the specified flow.
* <p>Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* <p>Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/ &lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CompareVersionsResponse compareVersions(VersionName baseVersion) {
Expand All @@ -959,8 +961,8 @@ public final CompareVersionsResponse compareVersions(VersionName baseVersion) {
*
* @param baseVersion Required. Name of the base flow version to compare with the target version.
* Use version ID `0` to indicate the draft version of the specified flow.
* <p>Format:
* `projects/&lt;ProjectID&gt;/locations/&lt;LocationID&gt;/agents/&lt;AgentID&gt;/flows/&lt;FlowID&gt;/versions/&lt;VersionID&gt;`.
* <p>Format: `projects/&lt;Project ID&gt;/locations/&lt;Location ID&gt;/agents/ &lt;Agent
* ID&gt;/flows/&lt;Flow ID&gt;/versions/&lt;Version ID&gt;`.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final CompareVersionsResponse compareVersions(String baseVersion) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,7 @@ public abstract static class VersionsImplBase implements io.grpc.BindableService
*
*
* <pre>
* Returns the list of all versions in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* </pre>
*/
public void listVersions(
Expand Down Expand Up @@ -426,13 +425,11 @@ public void getVersion(
*
*
* <pre>
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* 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`:
* [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
* </pre>
*/
Expand Down Expand Up @@ -579,8 +576,7 @@ protected VersionsStub build(io.grpc.Channel channel, io.grpc.CallOptions callOp
*
*
* <pre>
* Returns the list of all versions in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* </pre>
*/
public void listVersions(
Expand Down Expand Up @@ -611,13 +607,11 @@ public void getVersion(
*
*
* <pre>
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* 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`:
* [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
* </pre>
*/
Expand Down Expand Up @@ -725,8 +719,7 @@ protected VersionsBlockingStub build(io.grpc.Channel channel, io.grpc.CallOption
*
*
* <pre>
* Returns the list of all versions in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* </pre>
*/
public com.google.cloud.dialogflow.cx.v3.ListVersionsResponse listVersions(
Expand All @@ -752,13 +745,11 @@ public com.google.cloud.dialogflow.cx.v3.Version getVersion(
*
*
* <pre>
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* 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`:
* [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
* </pre>
*/
Expand Down Expand Up @@ -850,8 +841,7 @@ protected VersionsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
*
*
* <pre>
* Returns the list of all versions in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Returns the list of all versions in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
Expand Down Expand Up @@ -879,13 +869,11 @@ protected VersionsFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions
*
*
* <pre>
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified
* [Flow][google.cloud.dialogflow.cx.v3.Flow].
* Creates a [Version][google.cloud.dialogflow.cx.v3.Version] in the specified [Flow][google.cloud.dialogflow.cx.v3.Flow].
* 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`:
* [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `metadata`: [CreateVersionOperationMetadata][google.cloud.dialogflow.cx.v3.CreateVersionOperationMetadata]
* - `response`: [Version][google.cloud.dialogflow.cx.v3.Version]
* </pre>
*/
Expand Down
Loading

0 comments on commit b1affa6

Please sign in to comment.