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

Commit bb637f7

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
fix(docs): document fallback rest option (#72)
* 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 * docs: corrected the Dataflow job name regex PiperOrigin-RevId: 458015583 Source-Link: googleapis/googleapis@9b7d76e Source-Link: https://github.com/googleapis/googleapis-gen/commit/fb26a7ca71df63e4c527e9e607e57a382e8095f6 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZmIyNmE3Y2E3MWRmNjNlNGM1MjdlOWU2MDdlNTdhMzgyZTgwOTVmNiJ9 * 🦉 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 d92cb8d commit bb637f7

7 files changed

Lines changed: 31 additions & 37 deletions

File tree

‎protos/google/dataflow/v1beta3/jobs.proto‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ message Job {
154154
// existing Job.
155155
//
156156
// The name must match the regular expression
157-
// `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`
157+
// `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
158158
string name = 3;
159159

160160
// The type of Cloud Dataflow job.

‎src/v1beta3/flex_templates_service_client.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export class FlexTemplatesServiceClient {
6060
*
6161
* @param {object} [options] - The configuration object.
6262
* The options accepted by the constructor are described in detail
63-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
63+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
6464
* The common options are:
6565
* @param {object} [options.credentials] - Credentials object.
6666
* @param {string} [options.credentials.client_email]
@@ -83,11 +83,10 @@ export class FlexTemplatesServiceClient {
8383
* API remote host.
8484
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
8585
* Follows the structure of {@link gapicConfig}.
86-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
87-
* In fallback mode, a special browser-compatible transport implementation is used
88-
* instead of gRPC transport. In browser context (if the `window` object is defined)
89-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
90-
* if you need to override this behavior.
86+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
87+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
88+
* For more information, please check the
89+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
9190
*/
9291
constructor(opts?: ClientOptions) {
9392
// Ensure that options include all the required fields.

‎src/v1beta3/jobs_v1_beta3_client.ts‎

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

‎src/v1beta3/messages_v1_beta3_client.ts‎

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

‎src/v1beta3/metrics_v1_beta3_client.ts‎

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

‎src/v1beta3/snapshots_v1_beta3_client.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export class SnapshotsV1Beta3Client {
6060
*
6161
* @param {object} [options] - The configuration object.
6262
* The options accepted by the constructor are described in detail
63-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
63+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
6464
* The common options are:
6565
* @param {object} [options.credentials] - Credentials object.
6666
* @param {string} [options.credentials.client_email]
@@ -83,11 +83,10 @@ export class SnapshotsV1Beta3Client {
8383
* API remote host.
8484
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
8585
* Follows the structure of {@link gapicConfig}.
86-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
87-
* In fallback mode, a special browser-compatible transport implementation is used
88-
* instead of gRPC transport. In browser context (if the `window` object is defined)
89-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
90-
* if you need to override this behavior.
86+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
87+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
88+
* For more information, please check the
89+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
9190
*/
9291
constructor(opts?: ClientOptions) {
9392
// Ensure that options include all the required fields.

‎src/v1beta3/templates_service_client.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export class TemplatesServiceClient {
6060
*
6161
* @param {object} [options] - The configuration object.
6262
* The options accepted by the constructor are described in detail
63-
* in [this document](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#creating-the-client-instance).
63+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
6464
* The common options are:
6565
* @param {object} [options.credentials] - Credentials object.
6666
* @param {string} [options.credentials.client_email]
@@ -83,11 +83,10 @@ export class TemplatesServiceClient {
8383
* API remote host.
8484
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
8585
* Follows the structure of {@link gapicConfig}.
86-
* @param {boolean} [options.fallback] - Use HTTP fallback mode.
87-
* In fallback mode, a special browser-compatible transport implementation is used
88-
* instead of gRPC transport. In browser context (if the `window` object is defined)
89-
* the fallback mode is enabled automatically; set `options.fallback` to `false`
90-
* if you need to override this behavior.
86+
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
87+
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
88+
* For more information, please check the
89+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
9190
*/
9291
constructor(opts?: ClientOptions) {
9392
// Ensure that options include all the required fields.

0 commit comments

Comments
 (0)