@google-cloud/storage-control 0.6.0 → 0.7.0

package/build/src/v2/storage_client.js

@@ -0,0 +1,911 @@
+"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.StorageClient = void 0;
+const jsonProtos = require("../../protos/protos.json");
+const google_gax_1 = require("google-gax");
+/**
+ * Client JSON configuration object, loaded from
+ * `src/v2/storage_client_config.json`.
+ * This file defines retry strategy and timeouts for all API methods in this library.
+ */
+const gapicConfig = require("./storage_client_config.json");
+const version = require('../../../package.json').version;
+/**
+ *  ## API Overview and Naming Syntax
+ *
+ *  The Cloud Storage gRPC API allows applications to read and write data through
+ *  the abstractions of buckets and objects. For a description of these
+ *  abstractions please see [Cloud Storage
+ *  documentation](https://cloud.google.com/storage/docs).
+ *
+ *  Resources are named as follows:
+ *
+ *    - Projects are referred to as they are defined by the Resource Manager API,
+ *      using strings like `projects/123456` or `projects/my-string-id`.
+ *    - Buckets are named using string names of the form:
+ *      `projects/{project}/buckets/{bucket}`.
+ *      For globally unique buckets, `_` might be substituted for the project.
+ *    - Objects are uniquely identified by their name along with the name of the
+ *      bucket they belong to, as separate strings in this API. For example:
+ *
+ *          ```
+ *          ReadObjectRequest {
+ *          bucket: 'projects/_/buckets/my-bucket'
+ *          object: 'my-object'
+ *          }
+ *          ```
+ *
+ *  Note that object names can contain `/` characters, which are treated as
+ *  any other character (no special directory semantics).
+ * @class
+ * @memberof v2
+ */
+class StorageClient {
+    _terminated = false;
+    _opts;
+    _providedCustomServicePath;
+    _gaxModule;
+    _gaxGrpc;
+    _protos;
+    _defaults;
+    _universeDomain;
+    _servicePath;
+    _log = google_gax_1.loggingUtils.log('storage');
+    auth;
+    descriptors = {
+        page: {},
+        stream: {},
+        longrunning: {},
+        batching: {},
+    };
+    warn;
+    innerApiCalls;
+    pathTemplates;
+    storageStub;
+    /**
+     * Construct an instance of StorageClient.
+     *
+     * @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 StorageClient({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 = 'storage.' + 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 ?? {};
+        const fallback = opts?.fallback ??
+            (typeof window !== 'undefined' && typeof window?.fetch === 'function');
+        opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
+        // Request numeric enum values if REST transport is used.
+        opts.numericEnums = true;
+        // 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 useJWTAccessWithScope on the auth object.
+        this.auth.useJWTAccessWithScope = true;
+        // 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);
+        // This API contains "path templates"; forward-slash-separated
+        // identifiers to uniquely identify resources within the API.
+        // Create useful helper objects for these.
+        this.pathTemplates = {
+            bucketPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}'),
+            cryptoKeyPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}'),
+            projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
+        };
+        // 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 = {
+            listBuckets: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'buckets'),
+        };
+        // Put together the default options sent with requests.
+        this._defaults = this._gaxGrpc.constructSettings('google.storage.v2.Storage', 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.storageStub) {
+            return this.storageStub;
+        }
+        // Put together the "service stub" for
+        // google.storage.v2.Storage.
+        this.storageStub = this._gaxGrpc.createStub(this._opts.fallback
+            ? this._protos.lookupService('google.storage.v2.Storage')
+            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                this._protos.google.storage.v2.Storage, this._opts, this._providedCustomServicePath);
+        // Iterate over each of the methods that the service provides
+        // and create an API call method for each.
+        const storageStubMethods = [
+            'deleteBucket',
+            'getBucket',
+            'createBucket',
+            'listBuckets',
+            'lockBucketRetentionPolicy',
+            'updateBucket',
+        ];
+        for (const methodName of storageStubMethods) {
+            const callPromise = this.storageStub.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.storageStub;
+    }
+    /**
+     * 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 'storage.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 'storage.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/cloud-platform',
+            'https://www.googleapis.com/auth/cloud-platform.read-only',
+            'https://www.googleapis.com/auth/devstorage.full_control',
+            'https://www.googleapis.com/auth/devstorage.read_only',
+            'https://www.googleapis.com/auth/devstorage.read_write',
+        ];
+    }
+    /**
+     * 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();
+    }
+    deleteBucket(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<bucket>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['bucket'] ?? fieldValue;
+                    Object.assign(routingParameter, { bucket: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('deleteBucket request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('deleteBucket response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .deleteBucket(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('deleteBucket 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;
+        });
+    }
+    getBucket(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<bucket>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['bucket'] ?? fieldValue;
+                    Object.assign(routingParameter, { bucket: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('getBucket request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('getBucket response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .getBucket(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('getBucket 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;
+        });
+    }
+    createBucket(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue
+                    .toString()
+                    .match(RegExp('(?<project>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['project'] ?? fieldValue;
+                    Object.assign(routingParameter, { project: parameterValue });
+                }
+            }
+        }
+        {
+            const fieldValue = request.bucket?.project;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue
+                    .toString()
+                    .match(RegExp('(?<project>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['project'] ?? fieldValue;
+                    Object.assign(routingParameter, { project: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('createBucket request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('createBucket response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .createBucket(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('createBucket 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;
+        });
+    }
+    lockBucketRetentionPolicy(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.bucket;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<bucket>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['bucket'] ?? fieldValue;
+                    Object.assign(routingParameter, { bucket: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('lockBucketRetentionPolicy request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('lockBucketRetentionPolicy response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .lockBucketRetentionPolicy(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('lockBucketRetentionPolicy 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;
+        });
+    }
+    updateBucket(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.bucket?.name;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue.toString().match(RegExp('(?<bucket>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['bucket'] ?? fieldValue;
+                    Object.assign(routingParameter, { bucket: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('updateBucket request %j', request);
+        const wrappedCallback = callback
+            ? (error, response, options, rawResponse) => {
+                this._log.info('updateBucket response %j', response);
+                callback(error, response, options, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        return this.innerApiCalls
+            .updateBucket(request, options, wrappedCallback)
+            ?.then(([response, options, rawResponse]) => {
+            this._log.info('updateBucket 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;
+        });
+    }
+    listBuckets(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 || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue
+                    .toString()
+                    .match(RegExp('(?<project>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['project'] ?? fieldValue;
+                    Object.assign(routingParameter, { project: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        const wrappedCallback = callback
+            ? (error, values, nextPageRequest, rawResponse) => {
+                this._log.info('listBuckets values %j', values);
+                callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
+            }
+            : undefined;
+        this._log.info('listBuckets request %j', request);
+        return this.innerApiCalls
+            .listBuckets(request, options, wrappedCallback)
+            ?.then(([response, input, output]) => {
+            this._log.info('listBuckets values %j', response);
+            return [response, input, output];
+        });
+    }
+    /**
+     * Equivalent to `listBuckets`, but returns a NodeJS Stream object.
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The project whose buckets we are listing.
+     * @param {number} [request.pageSize]
+     *   Optional. Maximum number of buckets to return in a single response. The
+     *   service uses this parameter or `1,000` items, whichever is smaller. If
+     *   `acl` is present in the `read_mask`, the service uses this parameter of
+     *   `200` items, whichever is smaller.
+     * @param {string} [request.pageToken]
+     *   Optional. A previously-returned page token representing part of the larger
+     *   set of results to view.
+     * @param {string} [request.prefix]
+     *   Optional. Filter results to buckets whose names begin with this prefix.
+     * @param {google.protobuf.FieldMask} request.readMask
+     *   Mask specifying which fields to read from each result.
+     *   If no mask is specified, it defaults to all fields except `items.
+     *   owner`, `items.acl`, and `items.default_object_acl`.
+     *   `*` might be used to mean "all fields".
+     * @param {boolean} [request.returnPartialSuccess]
+     *   Optional. Allows listing of buckets, even if there are buckets that are
+     *   unreachable.
+     * @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.storage.v2.Bucket|Bucket} 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 `listBucketsAsync()`
+     *   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.
+     */
+    listBucketsStream(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue
+                    .toString()
+                    .match(RegExp('(?<project>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['project'] ?? fieldValue;
+                    Object.assign(routingParameter, { project: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        const defaultCallSettings = this._defaults['listBuckets'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('listBuckets stream %j', request);
+        return this.descriptors.page.listBuckets.createStream(this.innerApiCalls.listBuckets, request, callSettings);
+    }
+    /**
+     * Equivalent to `listBuckets`, 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.parent
+     *   Required. The project whose buckets we are listing.
+     * @param {number} [request.pageSize]
+     *   Optional. Maximum number of buckets to return in a single response. The
+     *   service uses this parameter or `1,000` items, whichever is smaller. If
+     *   `acl` is present in the `read_mask`, the service uses this parameter of
+     *   `200` items, whichever is smaller.
+     * @param {string} [request.pageToken]
+     *   Optional. A previously-returned page token representing part of the larger
+     *   set of results to view.
+     * @param {string} [request.prefix]
+     *   Optional. Filter results to buckets whose names begin with this prefix.
+     * @param {google.protobuf.FieldMask} request.readMask
+     *   Mask specifying which fields to read from each result.
+     *   If no mask is specified, it defaults to all fields except `items.
+     *   owner`, `items.acl`, and `items.default_object_acl`.
+     *   `*` might be used to mean "all fields".
+     * @param {boolean} [request.returnPartialSuccess]
+     *   Optional. Allows listing of buckets, even if there are buckets that are
+     *   unreachable.
+     * @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.storage.v2.Bucket|Bucket}. 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/v2/storage.list_buckets.js</caption>
+     * region_tag:storage_v2_generated_Storage_ListBuckets_async
+     */
+    listBucketsAsync(request, options) {
+        request = request || {};
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        const routingParameter = {};
+        {
+            const fieldValue = request.parent;
+            if (fieldValue !== undefined && fieldValue !== null) {
+                const match = fieldValue
+                    .toString()
+                    .match(RegExp('(?<project>(?:.*)?)'));
+                if (match) {
+                    const parameterValue = match.groups?.['project'] ?? fieldValue;
+                    Object.assign(routingParameter, { project: parameterValue });
+                }
+            }
+        }
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams(routingParameter);
+        const defaultCallSettings = this._defaults['listBuckets'];
+        const callSettings = defaultCallSettings.merge(options);
+        this.initialize().catch(err => {
+            throw err;
+        });
+        this._log.info('listBuckets iterate %j', request);
+        return this.descriptors.page.listBuckets.asyncIterate(this.innerApiCalls['listBuckets'], request, callSettings);
+    }
+    // --------------------
+    // -- Path templates --
+    // --------------------
+    /**
+     * Return a fully-qualified bucket resource name string.
+     *
+     * @param {string} project
+     * @param {string} bucket
+     * @returns {string} Resource name string.
+     */
+    bucketPath(project, bucket) {
+        return this.pathTemplates.bucketPathTemplate.render({
+            project: project,
+            bucket: bucket,
+        });
+    }
+    /**
+     * Parse the project from Bucket resource.
+     *
+     * @param {string} bucketName
+     *   A fully-qualified path representing Bucket resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromBucketName(bucketName) {
+        return this.pathTemplates.bucketPathTemplate.match(bucketName).project;
+    }
+    /**
+     * Parse the bucket from Bucket resource.
+     *
+     * @param {string} bucketName
+     *   A fully-qualified path representing Bucket resource.
+     * @returns {string} A string representing the bucket.
+     */
+    matchBucketFromBucketName(bucketName) {
+        return this.pathTemplates.bucketPathTemplate.match(bucketName).bucket;
+    }
+    /**
+     * Return a fully-qualified cryptoKey resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} key_ring
+     * @param {string} crypto_key
+     * @returns {string} Resource name string.
+     */
+    cryptoKeyPath(project, location, keyRing, cryptoKey) {
+        return this.pathTemplates.cryptoKeyPathTemplate.render({
+            project: project,
+            location: location,
+            key_ring: keyRing,
+            crypto_key: cryptoKey,
+        });
+    }
+    /**
+     * Parse the project from CryptoKey resource.
+     *
+     * @param {string} cryptoKeyName
+     *   A fully-qualified path representing CryptoKey resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromCryptoKeyName(cryptoKeyName) {
+        return this.pathTemplates.cryptoKeyPathTemplate.match(cryptoKeyName)
+            .project;
+    }
+    /**
+     * Parse the location from CryptoKey resource.
+     *
+     * @param {string} cryptoKeyName
+     *   A fully-qualified path representing CryptoKey resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromCryptoKeyName(cryptoKeyName) {
+        return this.pathTemplates.cryptoKeyPathTemplate.match(cryptoKeyName)
+            .location;
+    }
+    /**
+     * Parse the key_ring from CryptoKey resource.
+     *
+     * @param {string} cryptoKeyName
+     *   A fully-qualified path representing CryptoKey resource.
+     * @returns {string} A string representing the key_ring.
+     */
+    matchKeyRingFromCryptoKeyName(cryptoKeyName) {
+        return this.pathTemplates.cryptoKeyPathTemplate.match(cryptoKeyName)
+            .key_ring;
+    }
+    /**
+     * Parse the crypto_key from CryptoKey resource.
+     *
+     * @param {string} cryptoKeyName
+     *   A fully-qualified path representing CryptoKey resource.
+     * @returns {string} A string representing the crypto_key.
+     */
+    matchCryptoKeyFromCryptoKeyName(cryptoKeyName) {
+        return this.pathTemplates.cryptoKeyPathTemplate.match(cryptoKeyName)
+            .crypto_key;
+    }
+    /**
+     * Return a fully-qualified project resource name string.
+     *
+     * @param {string} project
+     * @returns {string} Resource name string.
+     */
+    projectPath(project) {
+        return this.pathTemplates.projectPathTemplate.render({
+            project: project,
+        });
+    }
+    /**
+     * Parse the project from Project resource.
+     *
+     * @param {string} projectName
+     *   A fully-qualified path representing Project resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectName(projectName) {
+        return this.pathTemplates.projectPathTemplate.match(projectName).project;
+    }
+    /**
+     * 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.storageStub && !this._terminated) {
+            return this.storageStub.then(stub => {
+                this._log.info('ending gRPC channel');
+                this._terminated = true;
+                stub.close();
+            });
+        }
+        return Promise.resolve();
+    }
+}
+exports.StorageClient = StorageClient;
+//# sourceMappingURL=storage_client.js.map