Skip to content

Commit 5db6ea0

Browse files
fix(docs): describe fallback rest option (#534)
* fix(docs): describe fallback rest option Use gapic-generator-typescript v2.15.1. PiperOrigin-RevId: 456946341 Source-Link: googleapis/googleapis@88fd18d Source-Link: googleapis/googleapis-gen@accfa37 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 2686443 commit 5db6ea0

File tree

2 files changed

+10
-12
lines changed

2 files changed

+10
-12
lines changed

packages/google-cloud-oslogin/src/v1/os_login_service_client.ts

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

packages/google-cloud-oslogin/src/v1beta/os_login_service_client.ts

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

0 commit comments

Comments
 (0)