@google-cloud/compute
Version:
Google Compute Engine Client Library for Node.js
1,250 lines • 60.2 kB
JavaScript
"use strict";
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ** This file is automatically generated by gapic-generator-typescript. **
// ** https://github.com/googleapis/gapic-generator-typescript **
// ** All changes to this file may be overwritten. **
Object.defineProperty(exports, "__esModule", { value: true });
exports.RegionNetworkFirewallPoliciesClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v1beta/region_network_firewall_policies_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./region_network_firewall_policies_client_config.json");
const version = require('../../../package.json').version;
/**
* The RegionNetworkFirewallPolicies API.
* @class
* @memberof v1beta
*/
class RegionNetworkFirewallPoliciesClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('compute');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
regionNetworkFirewallPoliciesStub;
/**
* Construct an instance of RegionNetworkFirewallPoliciesClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @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 RegionNetworkFirewallPoliciesClient({fallback: true}, gax);
* ```
*/
constructor(opts, gaxInstance) {
// Ensure that options include all the required fields.
const staticMembers = this.constructor;
if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
throw new Error('Please set either universe_domain or universeDomain, but not both.');
}
const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
this._servicePath = 'compute.' + this._universeDomain;
const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
const port = opts?.port || staticMembers.port;
const clientConfig = opts?.clientConfig ?? {};
// Implicitly enable HTTP transport for the APIs that use REST as transport (e.g. Google Cloud Compute).
if (!opts) {
opts = { fallback: true };
}
else {
opts.fallback = opts.fallback ?? true;
}
const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
// If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
if (servicePath !== this._servicePath && !('scopes' in opts)) {
opts['scopes'] = staticMembers.scopes;
}
// Load google-gax module synchronously if needed
if (!gaxInstance) {
gaxInstance = require('google-gax');
}
// Choose either gRPC or proto-over-HTTP implementation of google-gax.
this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
// Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
// Save options to use in initialize() method.
this._opts = opts;
// Save the auth object to the client, for use by other methods.
this.auth = this._gaxGrpc.auth;
// Set defaultServicePath on the auth object.
this.auth.defaultServicePath = this._servicePath;
// Set the default scopes in auth client if needed.
if (servicePath === this._servicePath) {
this.auth.defaultScopes = staticMembers.scopes;
}
// Determine the client header string.
const clientHeader = [
`gax/${this._gaxModule.version}`,
`gapic/${version}`,
];
if (typeof process === 'object' && 'versions' in process) {
clientHeader.push(`gl-node/${process.versions.node}`);
}
else {
clientHeader.push(`gl-web/${this._gaxModule.version}`);
}
if (!opts.fallback) {
clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
}
else {
clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
}
if (opts.libName && opts.libVersion) {
clientHeader.push(`${opts.libName}/${opts.libVersion}`);
}
// Load the applicable protos.
this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
// Some of the methods on this service return "paged" results,
// (e.g. 50 results at a time, with tokens to get subsequent
// pages). Denote the keys used for pagination and results.
this.descriptors.page = {
list: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'items')
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.compute.v1beta.RegionNetworkFirewallPolicies', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
// Set up a dictionary of "inner API calls"; the core implementation
// of calling the API is handled in `google-gax`, with this code
// merely providing the destination and request information.
this.innerApiCalls = {};
// Add a warn function to the client constructor so it can be easily tested.
this.warn = this._gaxModule.warn;
}
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize() {
// If the client stub promise is already initialized, return immediately.
if (this.regionNetworkFirewallPoliciesStub) {
return this.regionNetworkFirewallPoliciesStub;
}
// Put together the "service stub" for
// google.cloud.compute.v1beta.RegionNetworkFirewallPolicies.
this.regionNetworkFirewallPoliciesStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.cloud.compute.v1beta.RegionNetworkFirewallPolicies') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.compute.v1beta.RegionNetworkFirewallPolicies, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const regionNetworkFirewallPoliciesStubMethods = ['addAssociation', 'addRule', 'cloneRules', 'delete', 'get', 'getAssociation', 'getEffectiveFirewalls', 'getIamPolicy', 'getRule', 'insert', 'list', 'patch', 'patchAssociation', 'patchRule', 'removeAssociation', 'removeRule', 'setIamPolicy', 'testIamPermissions'];
for (const methodName of regionNetworkFirewallPoliciesStubMethods) {
const callPromise = this.regionNetworkFirewallPoliciesStub.then(stub => (...args) => {
if (this._terminated) {
return Promise.reject('The client has already been closed.');
}
const func = stub[methodName];
return func.apply(stub, args);
}, (err) => () => {
throw err;
});
const descriptor = this.descriptors.page[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.regionNetworkFirewallPoliciesStub;
}
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'compute.googleapis.com';
}
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint() {
if (typeof process === 'object' && typeof process.emitWarning === 'function') {
process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
}
return 'compute.googleapis.com';
}
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint() {
return this._servicePath;
}
get universeDomain() {
return this._universeDomain;
}
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port() {
return 443;
}
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes() {
return [
'https://www.googleapis.com/auth/compute',
'https://www.googleapis.com/auth/cloud-platform'
];
}
/**
* Return the project ID used by this class.
* @returns {Promise} A promise that resolves to string containing the project ID.
*/
getProjectId(callback) {
if (callback) {
this.auth.getProjectId(callback);
return;
}
return this.auth.getProjectId();
}
addAssociation(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('addAssociation request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('addAssociation response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.addAssociation(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
addRule(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('addRule request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('addRule response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.addRule(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
cloneRules(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('cloneRules request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('cloneRules response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.cloneRules(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
delete(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('delete request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('delete response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.delete(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
get(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('get request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('get response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.get(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('get response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getAssociation(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getAssociation request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getAssociation response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getAssociation(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getAssociation response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getEffectiveFirewalls(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getEffectiveFirewalls request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getEffectiveFirewalls response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getEffectiveFirewalls(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getEffectiveFirewalls response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getIamPolicy response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
getRule(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getRule request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getRule response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getRule(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getRule response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
insert(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('insert request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('insert response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.insert(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
patch(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('patch request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('patch response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.patch(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
patchAssociation(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('patchAssociation request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('patchAssociation response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.patchAssociation(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
patchRule(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('patchRule request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('patchRule response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.patchRule(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
removeAssociation(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('removeAssociation request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('removeAssociation response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.removeAssociation(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
removeRule(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'firewall_policy': request.firewallPolicy ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('removeRule request %j', request);
const wrappedCallback = callback
? (error, response, nextRequest, rawResponse) => {
this._log.info('removeRule response %j', rawResponse);
callback(error, response, nextRequest, rawResponse); // We verified `callback` above.
}
: undefined;
return this.innerApiCalls.removeRule(request, options, wrappedCallback)
?.then(([response, operation, rawResponse]) => {
return [
{ latestResponse: response, done: false, name: response.id, metadata: null, result: {} },
operation,
rawResponse
];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
setIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('setIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('setIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.setIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('setIamPolicy response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
testIamPermissions(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
'resource': request.resource ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('testIamPermissions request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('testIamPermissions response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.testIamPermissions(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('testIamPermissions response %j', response);
return [response, options, rawResponse];
}).catch((error) => {
if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
list(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
});
this.initialize().catch(err => { throw err; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('list values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('list request %j', request);
return this.innerApiCalls
.list(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('list values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `list`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.filter
* A filter expression that filters resources listed in the response. Most
* Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow
* API improvement proposal AIP-160.
* These two types of filter expressions cannot be mixed in one request.
*
* If you want to use AIP-160, your expression must specify the field name, an
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The operator
* must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
*
* For example, if you are filtering Compute Engine instances, you can
* exclude instances named `example-instance` by specifying
* `name != example-instance`.
*
* The `:*` comparison can be used to test whether a key has been defined.
* For example, to find all objects with `owner` label use:
* ```
* labels.owner:*
* ```
*
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only
* if they are not scheduled for automatic restarts. You can use filtering
* on nested fields to filter based onresource labels.
*
* To filter on multiple expressions, provide each separate expression within
* parentheses. For example:
* ```
* (scheduling.automaticRestart = true)
* (cpuPlatform = "Intel Skylake")
* ```
* By default, each expression is an `AND` expression. However, you
* can include `AND` and `OR` expressions explicitly.
* For example:
* ```
* (cpuPlatform = "Intel Skylake") OR
* (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true)
* ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne`
* (not equal) operator against a single un-parenthesized expression with or
* without quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal`
* `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"`
* `(fieldname1 eq literal) (fieldname2 ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
* The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular
* expressions.
* @param {number} request.maxResults
* The maximum number of results per page that should be returned.
* If the number of available results is larger than `maxResults`,
* Compute Engine returns a `nextPageToken` that can be used to get
* the next page of results in subsequent list requests. Acceptable values are
* `0` to `500`, inclusive. (Default: `500`)
* @param {string} request.orderBy
* Sorts list results by a certain order. By default, results
* are returned in alphanumerical order based on the resource name.
*
* You can also sort results in descending order based on the creation
* timestamp using `orderBy="creationTimestamp desc"`. This sorts
* results based on the `creationTimestamp` field in
* reverse chronological order (newest result first). Use this to sort
* resources like operations so that the newest operation is returned first.
*
* Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @param {string} request.pageToken
* Specifies a page token to use. Set `pageToken` to the
* `nextPageToken` returned by a previous list request to get
* the next page of results.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region scoping this request.
* @param {boolean} request.returnPartialSuccess
* Opt-in for partial success behavior which provides partial results in case
* of failure. The default value is false.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.compute.v1beta.FirewallPolicy|FirewallPolicy} on 'data' event.
* The client library will perform auto-pagination by default: it will call the API as many
* times as needed. Note that it can affect your quota.
* We recommend using `listAsync()`
* method described below for async iteration which you can stop as needed.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
*/
listStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
});
const defaultCallSettings = this._defaults['list'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('list stream %j', request);
return this.descriptors.page.list.createStream(this.innerApiCalls.list, request, callSettings);
}
/**
* Equivalent to `list`, but returns an iterable object.
*
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.filter
* A filter expression that filters resources listed in the response. Most
* Compute resources support two types of filter expressions:
* expressions that support regular expressions and expressions that follow
* API improvement proposal AIP-160.
* These two types of filter expressions cannot be mixed in one request.
*
* If you want to use AIP-160, your expression must specify the field name, an
* operator, and the value that you want to use for filtering. The value
* must be a string, a number, or a boolean. The operator
* must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.
*
* For example, if you are filtering Compute Engine instances, you can
* exclude instances named `example-instance` by specifying
* `name != example-instance`.
*
* The `:*` comparison can be used to test whether a key has been defined.
* For example, to find all objects with `owner` label use:
* ```
* labels.owner:*
* ```
*
* You can also filter nested fields. For example, you could specify
* `scheduling.automaticRestart = false` to include instances only
* if they are not scheduled for automatic restarts. You can use filtering
* on nested fields to filter based onresource labels.
*
* To filter on multiple expressions, provide each separate expression within
* parentheses. For example:
* ```
* (scheduling.automaticRestart = true)
* (cpuPlatform = "Intel Skylake")
* ```
* By default, each expression is an `AND` expression. However, you
* can include `AND` and `OR` expressions explicitly.
* For example:
* ```
* (cpuPlatform = "Intel Skylake") OR
* (cpuPlatform = "Intel Broadwell") AND
* (scheduling.automaticRestart = true)
* ```
*
* If you want to use a regular expression, use the `eq` (equal) or `ne`
* (not equal) operator against a single un-parenthesized expression with or
* without quotes or against multiple parenthesized expressions. Examples:
*
* `fieldname eq unquoted literal`
* `fieldname eq 'single quoted literal'`
* `fieldname eq "double quoted literal"`
* `(fieldname1 eq literal) (fieldname2 ne "literal")`
*
* The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
* The literal value must match the entire field.
*
* For example, to filter for instances that do not end with name "instance",
* you would use `name ne .*instance`.
*
* You cannot combine constraints on multiple fields using regular
* expressions.
* @param {number} request.maxResults
* The maximum number of results per page that should be returned.
* If the number of available results is larger than `maxResults`,
* Compute Engine returns a `nextPageToken` that can be used to get
* the next page of results in subsequent list requests. Acceptable values are
* `0` to `500`, inclusive. (Default: `500`)
* @param {string} request.orderBy
* Sorts list results by a certain order. By default, results
* are returned in alphanumerical order based on the resource name.
*
* You can also sort results in descending order based on the creation
* timestamp using `orderBy="creationTimestamp desc"`. This sorts
* results based on the `creationTimestamp` field in
* reverse chronological order (newest result first). Use this to sort
* resources like operations so that the newest operation is returned first.
*
* Currently, only sorting by `name` or
* `creationTimestamp desc` is supported.
* @param {string} request.pageToken
* Specifies a page token to use. Set `pageToken` to the
* `nextPageToken` returned by a previous list request to get
* the next page of results.
* @param {string} request.project
* Project ID for this request.
* @param {string} request.region
* Name of the region scoping this request.
* @param {boolean} request.returnPartialSuccess
* Opt-in for partial success behavior which provides partial results in case
* of failure. The default value is false.
*
* For example, when partial success behavior is enabled, aggregatedList for a
* single zone scope either returns all resources in the zone or no resources,
* with an error code.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.compute.v1beta.FirewallPolicy|FirewallPolicy}. The API will be called under the hood as needed, once per the page,
* so you can stop the iteration when you don't need more results.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1beta/region_network_firewall_policies.list.js</caption>
* region_tag:compute_v1beta_generated_RegionNetworkFirewallPolicies_List_async
*/
listAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
'project': request.project ?? '',
'region': request.region ?? '',
});
const defaultCallSettings = this._defaults['list'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('list iterate %j', request);
return this.descriptors.page.list.asyncIterate(this.innerApiCalls['list'], request, callSettings);
}
/**
* Terminate the gRPC channel and close the client.
*
* The client will no longer be usable and all future behavior is undefined.
* @returns {Promise} A promise that resolves when the client is closed.
*/
close() {
if (this.regionNetworkFirewallPoliciesStub && !this._terminated) {
return this.regionNetworkFirewallPoliciesStub.then(stub => {
this._log.info('ending gRPC channel');
this._terminated = true;
stub.close();
});
}
return Promise.resolve();
}
}
exports.RegionNetworkFirewallPoliciesClient = RegionNetworkFirewallPoliciesClient;
//# sourceMappingURL=region_network_firewall_policies_client.js.map