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

Commit 0368172

Browse files
fix(docs): describe fallback rest option (#143)
* 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 07b8044 commit 0368172

File tree

3 files changed

+15
-18
lines changed

3 files changed

+15
-18
lines changed

src/v1/quota_controller_client.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export class QuotaControllerClient {
6363
*
6464
* @param {object} [options] - The configuration object.
6565
* The options accepted by the constructor are described in detail
66-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
66+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
6767
* The common options are:
6868
* @param {object} [options.credentials] - Credentials object.
6969
* @param {string} [options.credentials.client_email]
@@ -86,11 +86,10 @@ export class QuotaControllerClient {
8686
* API remote host.
8787
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
8888
* Follows the structure of {@link gapicConfig}.
89-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
90-
* In fallback mode, a special browser-compatible transport implementation is used
91-
* instead of gRPC transport. In browser context (if the `window` object is defined)
92-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
93-
* if you need to override this behavior.
89+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
90+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
91+
* For more information, please check the
92+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
9493
*/
9594
constructor(opts?: ClientOptions) {
9695
// Ensure that options include all the required fields.

src/v1/service_controller_client.ts

+5-6
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export class ServiceControllerClient {
6363
*
6464
* @param {object} [options] - The configuration object.
6565
* The options accepted by the constructor are described in detail
66-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
66+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
6767
* The common options are:
6868
* @param {object} [options.credentials] - Credentials object.
6969
* @param {string} [options.credentials.client_email]
@@ -86,11 +86,10 @@ export class ServiceControllerClient {
8686
* API remote host.
8787
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
8888
* Follows the structure of {@link gapicConfig}.
89-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
90-
* In fallback mode, a special browser-compatible transport implementation is used
91-
* instead of gRPC transport. In browser context (if the `window` object is defined)
92-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
93-
* if you need to override this behavior.
89+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
90+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
91+
* For more information, please check the
92+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
9493
*/
9594
constructor(opts?: ClientOptions) {
9695
// Ensure that options include all the required fields.

src/v2/service_controller_client.ts

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

0 commit comments

Comments
 (0)