Skip to content
This repository was archived by the owner on Jul 13, 2023. It is now read-only.

Commit df558e9

Browse files
fix(docs): describe fallback rest option (#631)
* fix(docs): describe fallback rest option Use gapic-generator-typescript v2.15.1. PiperOrigin-RevId: 456946341 Source-Link: googleapis/googleapis@88fd18d Source-Link: https://github.com/googleapis/googleapis-gen/commit/accfa371f667439313335c64042b063c1c53102e Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYWNjZmEzNzFmNjY3NDM5MzEzMzM1YzY0MDQyYjA2M2MxYzUzMTAyZSJ9 * 🦉 Updates from OwlBot post-processor 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>
1 parent ee42868 commit df558e9

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed

src/v2/cloud_tasks_client.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export class CloudTasksClient {
7171
*
7272
* @param {object} [options] - The configuration object.
7373
* The options accepted by the constructor are described in detail
74-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
74+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
7575
* The common options are:
7676
* @param {object} [options.credentials] - Credentials object.
7777
* @param {string} [options.credentials.client_email]
@@ -94,11 +94,10 @@ export class CloudTasksClient {
9494
* API remote host.
9595
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
9696
* Follows the structure of {@link gapicConfig}.
97-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
98-
* In fallback mode, a special browser-compatible transport implementation is used
99-
* instead of gRPC transport. In browser context (if the `window` object is defined)
100-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
101-
* if you need to override this behavior.
97+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
98+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
99+
* For more information, please check the
100+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
102101
*/
103102
constructor(opts?: ClientOptions) {
104103
// Ensure that options include all the required fields.

src/v2beta2/cloud_tasks_client.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export class CloudTasksClient {
7171
*
7272
* @param {object} [options] - The configuration object.
7373
* The options accepted by the constructor are described in detail
74-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
74+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
7575
* The common options are:
7676
* @param {object} [options.credentials] - Credentials object.
7777
* @param {string} [options.credentials.client_email]
@@ -94,11 +94,10 @@ export class CloudTasksClient {
9494
* API remote host.
9595
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
9696
* Follows the structure of {@link gapicConfig}.
97-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
98-
* In fallback mode, a special browser-compatible transport implementation is used
99-
* instead of gRPC transport. In browser context (if the `window` object is defined)
100-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
101-
* if you need to override this behavior.
97+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
98+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
99+
* For more information, please check the
100+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
102101
*/
103102
constructor(opts?: ClientOptions) {
104103
// Ensure that options include all the required fields.

src/v2beta3/cloud_tasks_client.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ export class CloudTasksClient {
7171
*
7272
* @param {object} [options] - The configuration object.
7373
* The options accepted by the constructor are described in detail
74-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
74+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
7575
* The common options are:
7676
* @param {object} [options.credentials] - Credentials object.
7777
* @param {string} [options.credentials.client_email]
@@ -94,11 +94,10 @@ export class CloudTasksClient {
9494
* API remote host.
9595
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
9696
* Follows the structure of {@link gapicConfig}.
97-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
98-
* In fallback mode, a special browser-compatible transport implementation is used
99-
* instead of gRPC transport. In browser context (if the `window` object is defined)
100-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
101-
* if you need to override this behavior.
97+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
98+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
99+
* For more information, please check the
100+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
102101
*/
103102
constructor(opts?: ClientOptions) {
104103
// Ensure that options include all the required fields.

0 commit comments

Comments
 (0)