Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: [Many APIs] simplify logic for HTTP/1.1 REST fallback option #4584

Merged
merged 3 commits into from
Aug 25, 2023
Merged

fix: [Many APIs] simplify logic for HTTP/1.1 REST fallback option #4584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b2bb0b
fix: simplify logic for HTTP/1.1 REST fallback option
gcf-owl-bot[bot] Aug 24, 2023
5391f21
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 24, 2023
6029e63
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions packages/google-cloud-beyondcorp-appconnectors/src/v1/app_connectors_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,15 @@ export class AppConnectorsServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new AppConnectorsServiceClient({fallback: 'rest'}, gax);
* const client = new AppConnectorsServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -193,7 +192,7 @@ export class AppConnectorsServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down Expand Up @@ -236,7 +235,7 @@ export class AppConnectorsServiceClient {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
};
if (opts.fallback === 'rest') {
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [
{
Expand Down
9 changes: 4 additions & 5 deletions packages/google-cloud-beyondcorp-appgateways/src/v1/app_gateways_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,16 +112,15 @@ export class AppGatewaysServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new AppGatewaysServiceClient({fallback: 'rest'}, gax);
* const client = new AppGatewaysServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -193,7 +192,7 @@ export class AppGatewaysServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down Expand Up @@ -236,7 +235,7 @@ export class AppGatewaysServiceClient {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
};
if (opts.fallback === 'rest') {
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [
{
Expand Down
9 changes: 4 additions & 5 deletions ...oud-beyondcorp-clientconnectorservices/src/v1/client_connector_services_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,15 @@ export class ClientConnectorServicesServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ClientConnectorServicesServiceClient({fallback: 'rest'}, gax);
* const client = new ClientConnectorServicesServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -191,7 +190,7 @@ export class ClientConnectorServicesServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down Expand Up @@ -234,7 +233,7 @@ export class ClientConnectorServicesServiceClient {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
};
if (opts.fallback === 'rest') {
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [
{
Expand Down
5 changes: 3 additions & 2 deletions packages/google-cloud-beyondcorp-clientgateways/samples/quickstart.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,9 @@ function main(parent) {
};

// Run request
const iterable =
await clientgatewaysClient.listClientGatewaysAsync(request);
const iterable = await clientgatewaysClient.listClientGatewaysAsync(
request
);
for await (const response of iterable) {
console.log(response);
}
Expand Down
9 changes: 4 additions & 5 deletions packages/google-cloud-beyondcorp-clientgateways/src/v1/client_gateways_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,15 @@ export class ClientGatewaysServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ClientGatewaysServiceClient({fallback: 'rest'}, gax);
* const client = new ClientGatewaysServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -191,7 +190,7 @@ export class ClientGatewaysServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down Expand Up @@ -234,7 +233,7 @@ export class ClientGatewaysServiceClient {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
};
if (opts.fallback === 'rest') {
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [
{
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-analyticshub/src/v1/analytics_hub_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,15 @@ export class AnalyticsHubServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new AnalyticsHubServiceClient({fallback: 'rest'}, gax);
* const client = new AnalyticsHubServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -167,7 +166,7 @@ export class AnalyticsHubServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-connection/src/v1/connection_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,15 @@ export class ConnectionServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ConnectionServiceClient({fallback: 'rest'}, gax);
* const client = new ConnectionServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -165,7 +164,7 @@ export class ConnectionServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-connection/src/v1beta1/connection_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,15 @@ export class ConnectionServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ConnectionServiceClient({fallback: 'rest'}, gax);
* const client = new ConnectionServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -163,7 +162,7 @@ export class ConnectionServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-dataexchange/src/v1beta1/analytics_hub_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,15 @@ export class AnalyticsHubServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new AnalyticsHubServiceClient({fallback: 'rest'}, gax);
* const client = new AnalyticsHubServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -174,7 +173,7 @@ export class AnalyticsHubServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-datapolicies/src/v1/data_policy_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,15 @@ export class DataPolicyServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new DataPolicyServiceClient({fallback: 'rest'}, gax);
* const client = new DataPolicyServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -165,7 +164,7 @@ export class DataPolicyServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-datapolicies/src/v1beta1/data_policy_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,16 +90,15 @@ export class DataPolicyServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new DataPolicyServiceClient({fallback: 'rest'}, gax);
* const client = new DataPolicyServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -162,7 +161,7 @@ export class DataPolicyServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-datatransfer/src/v1/data_transfer_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,16 +93,15 @@ export class DataTransferServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new DataTransferServiceClient({fallback: 'rest'}, gax);
* const client = new DataTransferServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -172,7 +171,7 @@ export class DataTransferServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
7 changes: 3 additions & 4 deletions packages/google-cloud-bigquery-reservation/src/v1/reservation_service_client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,16 +104,15 @@ export class ReservationServiceClient {
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new ReservationServiceClient({fallback: 'rest'}, gax);
* const client = new ReservationServiceClient({fallback: true}, gax);
* ```
*/
constructor(
Expand Down Expand Up @@ -179,7 +178,7 @@ export class ReservationServiceClient {
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
} else if (opts.fallback === 'rest') {
} else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
Expand Down
Loading
Loading