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

Commit df8b28f

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
fix(docs): document fallback rest option (#561)
* feat: support regapic LRO 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 22ed340 commit df8b28f

2 files changed

Lines changed: 10 additions & 12 deletions

File tree

‎src/v1/ekm_service_client.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ export class EkmServiceClient {
7777
*
7878
* @param {object} [options] - The configuration object.
7979
* The options accepted by the constructor are described in detail
80-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
80+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
8181
* The common options are:
8282
* @param {object} [options.credentials] - Credentials object.
8383
* @param {string} [options.credentials.client_email]
@@ -100,11 +100,10 @@ export class EkmServiceClient {
100100
* API remote host.
101101
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
102102
* Follows the structure of {@link gapicConfig}.
103-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
104-
* In fallback mode, a special browser-compatible transport implementation is used
105-
* instead of gRPC transport. In browser context (if the `window` object is defined)
106-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
107-
* if you need to override this behavior.
103+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
104+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
105+
* For more information, please check the
106+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
108107
*/
109108
constructor(opts?: ClientOptions) {
110109
// Ensure that options include all the required fields.

‎src/v1/key_management_service_client.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ export class KeyManagementServiceClient {
8484
*
8585
* @param {object} [options] - The configuration object.
8686
* The options accepted by the constructor are described in detail
87-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
87+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
8888
* The common options are:
8989
* @param {object} [options.credentials] - Credentials object.
9090
* @param {string} [options.credentials.client_email]
@@ -107,11 +107,10 @@ export class KeyManagementServiceClient {
107107
* API remote host.
108108
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
109109
* Follows the structure of {@link gapicConfig}.
110-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
111-
* In fallback mode, a special browser-compatible transport implementation is used
112-
* instead of gRPC transport. In browser context (if the `window` object is defined)
113-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
114-
* if you need to override this behavior.
110+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
111+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
112+
* For more information, please check the
113+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
115114
*/
116115
constructor(opts?: ClientOptions) {
117116
// Ensure that options include all the required fields.

0 commit comments

Comments
 (0)