@google-cloud/storage-control
Version:
Cloud Storage API client for Node.js
2,254 lines • 111 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.StorageControlClient = void 0;
/* global window */
const gax = require("google-gax");
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v2/storage_control_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./storage_control_client_config.json");
const version = require('../../../package.json').version;
/**
* StorageControl service includes selected control plane operations.
* @class
* @memberof v2
*/
class StorageControlClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('storage-control');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
operationsClient;
storageControlStub;
/**
* Construct an instance of StorageControlClient.
*
* @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 StorageControlClient({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 = {
anywhereCachePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}'),
bucketPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}'),
folderPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}/folders/{folder=**}'),
folderLocationIntelligenceConfigPathTemplate: new this._gaxModule.PathTemplate('folders/{folder}/locations/{location}/intelligenceConfig'),
managedFolderPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}/managedFolders/{managed_folder=**}'),
orgLocationIntelligenceConfigPathTemplate: new this._gaxModule.PathTemplate('organizations/{org}/locations/{location}/intelligenceConfig'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
projectLocationIntelligenceConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/intelligenceConfig'),
storageLayoutPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/buckets/{bucket}/storageLayout'),
};
// 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 = {
listFolders: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'folders'),
listManagedFolders: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'managedFolders'),
listAnywhereCaches: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'anywhereCaches')
};
const protoFilesRoot = this._gaxModule.protobufFromJSON(jsonProtos);
// This API contains "long-running operations", which return a
// an Operation object that allows for tracking of the operation,
// rather than holding a request open.
const lroOptions = {
auth: this.auth,
grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined
};
if (opts.fallback) {
lroOptions.protoJson = protoFilesRoot;
lroOptions.httpRules = [];
}
this.operationsClient = this._gaxModule.lro(lroOptions).operationsClient(opts);
const renameFolderResponse = protoFilesRoot.lookup('.google.storage.control.v2.Folder');
const renameFolderMetadata = protoFilesRoot.lookup('.google.storage.control.v2.RenameFolderMetadata');
const createAnywhereCacheResponse = protoFilesRoot.lookup('.google.storage.control.v2.AnywhereCache');
const createAnywhereCacheMetadata = protoFilesRoot.lookup('.google.storage.control.v2.CreateAnywhereCacheMetadata');
const updateAnywhereCacheResponse = protoFilesRoot.lookup('.google.storage.control.v2.AnywhereCache');
const updateAnywhereCacheMetadata = protoFilesRoot.lookup('.google.storage.control.v2.UpdateAnywhereCacheMetadata');
this.descriptors.longrunning = {
renameFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, renameFolderResponse.decode.bind(renameFolderResponse), renameFolderMetadata.decode.bind(renameFolderMetadata)),
createAnywhereCache: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createAnywhereCacheResponse.decode.bind(createAnywhereCacheResponse), createAnywhereCacheMetadata.decode.bind(createAnywhereCacheMetadata)),
updateAnywhereCache: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateAnywhereCacheResponse.decode.bind(updateAnywhereCacheResponse), updateAnywhereCacheMetadata.decode.bind(updateAnywhereCacheMetadata))
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.storage.control.v2.StorageControl', 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.storageControlStub) {
return this.storageControlStub;
}
// Put together the "service stub" for
// google.storage.control.v2.StorageControl.
this.storageControlStub = this._gaxGrpc.createStub(this._opts.fallback ?
this._protos.lookupService('google.storage.control.v2.StorageControl') :
// eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.storage.control.v2.StorageControl, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const storageControlStubMethods = ['createFolder', 'deleteFolder', 'getFolder', 'listFolders', 'renameFolder', 'getStorageLayout', 'createManagedFolder', 'deleteManagedFolder', 'getManagedFolder', 'listManagedFolders', 'createAnywhereCache', 'updateAnywhereCache', 'disableAnywhereCache', 'pauseAnywhereCache', 'resumeAnywhereCache', 'getAnywhereCache', 'listAnywhereCaches', 'getProjectIntelligenceConfig', 'updateProjectIntelligenceConfig', 'getFolderIntelligenceConfig', 'updateFolderIntelligenceConfig', 'getOrganizationIntelligenceConfig', 'updateOrganizationIntelligenceConfig'];
for (const methodName of storageControlStubMethods) {
const callPromise = this.storageControlStub.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] ||
this.descriptors.longrunning[methodName] ||
undefined;
const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
this.innerApiCalls[methodName] = apiCall;
}
return this.storageControlStub;
}
/**
* 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();
}
createFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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('createFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.createFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createFolder 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;
});
}
deleteFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('deleteFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.deleteFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteFolder 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;
});
}
getFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('getFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getFolder 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;
});
}
getStorageLayout(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('getStorageLayout request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getStorageLayout response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getStorageLayout(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getStorageLayout 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;
});
}
createManagedFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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('createManagedFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('createManagedFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.createManagedFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('createManagedFolder 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;
});
}
deleteManagedFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('deleteManagedFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('deleteManagedFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.deleteManagedFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('deleteManagedFolder 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;
});
}
getManagedFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('getManagedFolder request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getManagedFolder response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getManagedFolder(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getManagedFolder 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;
});
}
disableAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('disableAnywhereCache request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('disableAnywhereCache response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.disableAnywhereCache(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('disableAnywhereCache 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;
});
}
pauseAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('pauseAnywhereCache request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('pauseAnywhereCache response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.pauseAnywhereCache(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('pauseAnywhereCache 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;
});
}
resumeAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('resumeAnywhereCache request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('resumeAnywhereCache response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.resumeAnywhereCache(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('resumeAnywhereCache 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;
});
}
getAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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('getAnywhereCache request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getAnywhereCache response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getAnywhereCache(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getAnywhereCache 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;
});
}
getProjectIntelligenceConfig(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({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getProjectIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getProjectIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getProjectIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getProjectIntelligenceConfig 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;
});
}
updateProjectIntelligenceConfig(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({
'intelligence_config.name': request.intelligenceConfig.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateProjectIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateProjectIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.updateProjectIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateProjectIntelligenceConfig 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;
});
}
getFolderIntelligenceConfig(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({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getFolderIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getFolderIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getFolderIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getFolderIntelligenceConfig 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;
});
}
updateFolderIntelligenceConfig(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({
'intelligence_config.name': request.intelligenceConfig.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateFolderIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateFolderIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.updateFolderIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateFolderIntelligenceConfig 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;
});
}
getOrganizationIntelligenceConfig(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({
'name': request.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('getOrganizationIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getOrganizationIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.getOrganizationIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getOrganizationIntelligenceConfig 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;
});
}
updateOrganizationIntelligenceConfig(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({
'intelligence_config.name': request.intelligenceConfig.name ?? '',
});
this.initialize().catch(err => { throw err; });
this._log.info('updateOrganizationIntelligenceConfig request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('updateOrganizationIntelligenceConfig response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls.updateOrganizationIntelligenceConfig(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('updateOrganizationIntelligenceConfig 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;
});
}
renameFolder(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('renameFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('renameFolder request %j', request);
return this.innerApiCalls.renameFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('renameFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `renameFolder()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/storage_control.rename_folder.js</caption>
* region_tag:storage_v2_generated_StorageControl_RenameFolder_async
*/
async checkRenameFolderProgress(name) {
this._log.info('renameFolder long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.renameFolder, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
createAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('createAnywhereCache response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('createAnywhereCache request %j', request);
return this.innerApiCalls.createAnywhereCache(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('createAnywhereCache response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `createAnywhereCache()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/storage_control.create_anywhere_cache.js</caption>
* region_tag:storage_v2_generated_StorageControl_CreateAnywhereCache_async
*/
async checkCreateAnywhereCacheProgress(name) {
this._log.info('createAnywhereCache long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createAnywhereCache, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
updateAnywhereCache(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.anywhereCache?.name;
if (fieldValue !== undefined && fieldValue !== null) {
const match = fieldValue.toString().match(RegExp('(?<bucket>projects/[^/]+/buckets/[^/]+)(?:/.*)?'));
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; });
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('updateAnywhereCache response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('updateAnywhereCache request %j', request);
return this.innerApiCalls.updateAnywhereCache(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('updateAnywhereCache response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `updateAnywhereCache()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v2/storage_control.update_anywhere_cache.js</caption>
* region_tag:storage_v2_generated_StorageControl_UpdateAnywhereCache_async
*/
async checkUpdateAnywhereCacheProgress(name) {
this._log.info('updateAnywhereCache long-running');
const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
const [operation] = await this.operationsClient.getOperation(request);
const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.updateAnywhereCache, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
listFolders(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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listFolders values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listFolders request %j', request);
return this.innerApiCalls
.listFolders(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listFolders values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listFolders`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Name of the bucket in which to look for folders. The bucket must
* be a hierarchical namespace enabled bucket.
* @param {number} [request.pageSize]
* Optional. Maximum number of folders to return in a single response. The
* service will use this parameter or 1,000 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 folders whose names begin with this prefix.
* If set, the value must either be an empty string or end with a '/'.
* @param {string} [request.delimiter]
* Optional. If set, returns results in a directory-like mode. The results
* will only include folders that either exactly match the above prefix, or
* are one level below the prefix. The only supported value is '/'.
* @param {string} [request.lexicographicStart]
* Optional. Filter results to folders whose names are lexicographically equal
* to or after lexicographic_start. If lexicographic_end is also set, the
* folders listed have names between lexicographic_start (inclusive) and
* lexicographic_end (exclusive).
* @param {string} [request.lexicographicEnd]
* Optional. Filter results to folders whose names are lexicographically
* before lexicographic_end. If lexicographic_start is also set, the folders
* listed have names between lexicographic_start (inclusive) and
* lexicographic_end (exclusive).
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.Folder|Folder} 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 `listFoldersAsync()`
* 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.
*/
listFoldersStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listFolders stream %j', request);
return this.descriptors.page.listFolders.createStream(this.innerApiCalls.listFolders, request, callSettings);
}
/**
* Equivalent to `listFolders`, 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. Name of the bucket in which to look for folders. The bucket must
* be a hierarchical namespace enabled bucket.
* @param {number} [request.pageSize]
* Optional. Maximum number of folders to return in a single response. The
* service will use this parameter or 1,000 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 folders whose names begin with this prefix.
* If set, the value must either be an empty string or end with a '/'.
* @param {string} [request.delimiter]
* Optional. If set, returns results in a directory-like mode. The results
* will only include folders that either exactly match the above prefix, or
* are one level below the prefix. The only supported value is '/'.
* @param {string} [request.lexicographicStart]
* Optional. Filter results to folders whose names are lexicographically equal
* to or after lexicographic_start. If lexicographic_end is also set, the
* folders listed have names between lexicographic_start (inclusive) and
* lexicographic_end (exclusive).
* @param {string} [request.lexicographicEnd]
* Optional. Filter results to folders whose names are lexicographically
* before lexicographic_end. If lexicographic_start is also set, the folders
* listed have names between lexicographic_start (inclusive) and
* lexicographic_end (exclusive).
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.Folder|Folder}. 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_control.list_folders.js</caption>
* region_tag:storage_v2_generated_StorageControl_ListFolders_async
*/
listFoldersAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listFolders iterate %j', request);
return this.descriptors.page.listFolders.asyncIterate(this.innerApiCalls['listFolders'], request, callSettings);
}
listManagedFolders(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listManagedFolders values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listManagedFolders request %j', request);
return this.innerApiCalls
.listManagedFolders(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listManagedFolders values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listManagedFolders`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. Name of the bucket this managed folder belongs to.
* @param {number} [request.pageSize]
* Optional. Maximum number of managed folders to return in a single response.
* The service will use this parameter or 1,000 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 match managed folders with name starting with
* this prefix.
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.ManagedFolder|ManagedFolder} 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 `listManagedFoldersAsync()`
* 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.
*/
listManagedFoldersStream(request, options) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listManagedFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listManagedFolders stream %j', request);
return this.descriptors.page.listManagedFolders.createStream(this.innerApiCalls.listManagedFolders, request, callSettings);
}
/**
* Equivalent to `listManagedFolders`, 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. Name of the bucket this managed folder belongs to.
* @param {number} [request.pageSize]
* Optional. Maximum number of managed folders to return in a single response.
* The service will use this parameter or 1,000 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 match managed folders with name starting with
* this prefix.
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.ManagedFolder|ManagedFolder}. 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_control.list_managed_folders.js</caption>
* region_tag:storage_v2_generated_StorageControl_ListManagedFolders_async
*/
listManagedFoldersAsync(request, options) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listManagedFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listManagedFolders iterate %j', request);
return this.descriptors.page.listManagedFolders.asyncIterate(this.innerApiCalls['listManagedFolders'], request, callSettings);
}
listAnywhereCaches(request, optionsOrCallback, callback) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
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 || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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; });
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('listAnywhereCaches values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('listAnywhereCaches request %j', request);
return this.innerApiCalls
.listAnywhereCaches(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('listAnywhereCaches values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `listAnywhereCaches`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The bucket to which this cache belongs.
* @param {number} request.pageSize
* Maximum number of caches to return in a single response.
* The service will use this parameter or 1,000 items, whichever is smaller.
* @param {string} request.pageToken
* A previously-returned page token representing part of the larger set of
* results to view.
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.AnywhereCache|AnywhereCache} 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 `listAnywhereCachesAsync()`
* 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.
*/
listAnywhereCachesStream(request, options) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listAnywhereCaches'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listAnywhereCaches stream %j', request);
return this.descriptors.page.listAnywhereCaches.createStream(this.innerApiCalls.listAnywhereCaches, request, callSettings);
}
/**
* Equivalent to `listAnywhereCaches`, 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 bucket to which this cache belongs.
* @param {number} request.pageSize
* Maximum number of caches to return in a single response.
* The service will use this parameter or 1,000 items, whichever is smaller.
* @param {string} request.pageToken
* A previously-returned page token representing part of the larger set of
* results to view.
* @param {string} [request.requestId]
* Optional. A unique identifier for this request. UUID is the recommended
* format, but other formats are still accepted.
* @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.control.v2.AnywhereCache|AnywhereCache}. 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_control.list_anywhere_caches.js</caption>
* region_tag:storage_v2_generated_StorageControl_ListAnywhereCaches_async
*/
listAnywhereCachesAsync(request, options) {
request = request || {};
if (!request.requestId) {
request.requestId = gax.makeUUID();
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
let routingParameter = {};
{
const fieldValue = request.parent;
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);
const defaultCallSettings = this._defaults['listAnywhereCaches'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch(err => { throw err; });
this._log.info('listAnywhereCaches iterate %j', request);
return this.descriptors.page.listAnywhereCaches.asyncIterate(this.innerApiCalls['listAnywhereCaches'], request, callSettings);
}
/**
* Gets the latest state of a long-running operation. Clients can use this
* method to poll the operation result at intervals as recommended by the API
* service.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error, ?Object)=} callback
* The function which will be called with the result of the API call.
*
* The second parameter to the callback is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* @return {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* {@link google.longrunning.Operation | google.longrunning.Operation}.
* The promise has a method named "cancel" which cancels the ongoing API call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* const name = '';
* const [response] = await client.getOperation({name});
* // doThingsWith(response)
* ```
*/
getOperation(request, optionsOrCallback, callback) {
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({
name: request.name ?? '',
});
return this.operationsClient.getOperation(request, options, callback);
}
/**
* Lists operations that match the specified filter in the request. If the
* server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
*
* For-await-of syntax is used with the iterable to recursively get response element on-demand.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation collection.
* @param {string} request.filter - The standard list filter.
* @param {number=} request.pageSize -
* The maximum number of resources contained in the underlying API
* response. If page streaming is performed per-resource, this
* parameter does not affect the return value. If page streaming is
* performed per-page, this determines the maximum number of
* resources in a page.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @returns {Object}
* An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
*
* @example
* ```
* const client = longrunning.operationsClient();
* for await (const response of client.listOperationsAsync(request));
* // doThingsWith(response)
* ```
*/
listOperationsAsync(request, options) {
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
name: request.name ?? '',
});
return this.operationsClient.listOperationsAsync(request, options);
}
/**
* Starts asynchronous cancellation on a long-running operation. The server
* makes a best effort to cancel the operation, but success is not
* guaranteed. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`. Clients can use
* {@link Operations.GetOperation} or
* other methods to check whether the cancellation succeeded or whether the
* operation completed despite cancellation. On successful cancellation,
* the operation is not deleted; instead, it becomes an operation with
* an {@link Operation.error} value with a {@link google.rpc.Status.code} of
* 1, corresponding to `Code.CANCELLED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be cancelled.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
* details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.cancelOperation({name: ''});
* ```
*/
cancelOperation(request, optionsOrCallback, callback) {
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({
name: request.name ?? '',
});
return this.operationsClient.cancelOperation(request, options, callback);
}
/**
* Deletes a long-running operation. This method indicates that the client is
* no longer interested in the operation result. It does not cancel the
* operation. If the server doesn't support this method, it returns
* `google.rpc.Code.UNIMPLEMENTED`.
*
* @param {Object} request - The request object that will be sent.
* @param {string} request.name - The name of the operation resource to be deleted.
* @param {Object=} options
* Optional parameters. You can override the default settings for this call,
* e.g, timeout, retries, paginations, etc. See {@link
* https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
* for the details.
* @param {function(?Error)=} callback
* The function which will be called with the result of the API call.
* @return {Promise} - The promise which resolves when API call finishes.
* The promise has a method named "cancel" which cancels the ongoing API
* call.
*
* @example
* ```
* const client = longrunning.operationsClient();
* await client.deleteOperation({name: ''});
* ```
*/
deleteOperation(request, optionsOrCallback, callback) {
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({
name: request.name ?? '',
});
return this.operationsClient.deleteOperation(request, options, callback);
}
// --------------------
// -- Path templates --
// --------------------
/**
* Return a fully-qualified anywhereCache resource name string.
*
* @param {string} project
* @param {string} bucket
* @param {string} anywhere_cache
* @returns {string} Resource name string.
*/
anywhereCachePath(project, bucket, anywhereCache) {
return this.pathTemplates.anywhereCachePathTemplate.render({
project: project,
bucket: bucket,
anywhere_cache: anywhereCache,
});
}
/**
* Parse the project from AnywhereCache resource.
*
* @param {string} anywhereCacheName
* A fully-qualified path representing AnywhereCache resource.
* @returns {string} A string representing the project.
*/
matchProjectFromAnywhereCacheName(anywhereCacheName) {
return this.pathTemplates.anywhereCachePathTemplate.match(anywhereCacheName).project;
}
/**
* Parse the bucket from AnywhereCache resource.
*
* @param {string} anywhereCacheName
* A fully-qualified path representing AnywhereCache resource.
* @returns {string} A string representing the bucket.
*/
matchBucketFromAnywhereCacheName(anywhereCacheName) {
return this.pathTemplates.anywhereCachePathTemplate.match(anywhereCacheName).bucket;
}
/**
* Parse the anywhere_cache from AnywhereCache resource.
*
* @param {string} anywhereCacheName
* A fully-qualified path representing AnywhereCache resource.
* @returns {string} A string representing the anywhere_cache.
*/
matchAnywhereCacheFromAnywhereCacheName(anywhereCacheName) {
return this.pathTemplates.anywhereCachePathTemplate.match(anywhereCacheName).anywhere_cache;
}
/**
* 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 folder resource name string.
*
* @param {string} project
* @param {string} bucket
* @param {string} folder
* @returns {string} Resource name string.
*/
folderPath(project, bucket, folder) {
return this.pathTemplates.folderPathTemplate.render({
project: project,
bucket: bucket,
folder: folder,
});
}
/**
* Parse the project from Folder resource.
*
* @param {string} folderName
* A fully-qualified path representing Folder resource.
* @returns {string} A string representing the project.
*/
matchProjectFromFolderName(folderName) {
return this.pathTemplates.folderPathTemplate.match(folderName).project;
}
/**
* Parse the bucket from Folder resource.
*
* @param {string} folderName
* A fully-qualified path representing Folder resource.
* @returns {string} A string representing the bucket.
*/
matchBucketFromFolderName(folderName) {
return this.pathTemplates.folderPathTemplate.match(folderName).bucket;
}
/**
* Parse the folder from Folder resource.
*
* @param {string} folderName
* A fully-qualified path representing Folder resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderName(folderName) {
return this.pathTemplates.folderPathTemplate.match(folderName).folder;
}
/**
* Return a fully-qualified folderLocationIntelligenceConfig resource name string.
*
* @param {string} folder
* @param {string} location
* @returns {string} Resource name string.
*/
folderLocationIntelligenceConfigPath(folder, location) {
return this.pathTemplates.folderLocationIntelligenceConfigPathTemplate.render({
folder: folder,
location: location,
});
}
/**
* Parse the folder from FolderLocationIntelligenceConfig resource.
*
* @param {string} folderLocationIntelligenceConfigName
* A fully-qualified path representing folder_location_intelligenceConfig resource.
* @returns {string} A string representing the folder.
*/
matchFolderFromFolderLocationIntelligenceConfigName(folderLocationIntelligenceConfigName) {
return this.pathTemplates.folderLocationIntelligenceConfigPathTemplate.match(folderLocationIntelligenceConfigName).folder;
}
/**
* Parse the location from FolderLocationIntelligenceConfig resource.
*
* @param {string} folderLocationIntelligenceConfigName
* A fully-qualified path representing folder_location_intelligenceConfig resource.
* @returns {string} A string representing the location.
*/
matchLocationFromFolderLocationIntelligenceConfigName(folderLocationIntelligenceConfigName) {
return this.pathTemplates.folderLocationIntelligenceConfigPathTemplate.match(folderLocationIntelligenceConfigName).location;
}
/**
* Return a fully-qualified managedFolder resource name string.
*
* @param {string} project
* @param {string} bucket
* @param {string} managed_folder
* @returns {string} Resource name string.
*/
managedFolderPath(project, bucket, managedFolder) {
return this.pathTemplates.managedFolderPathTemplate.render({
project: project,
bucket: bucket,
managed_folder: managedFolder,
});
}
/**
* Parse the project from ManagedFolder resource.
*
* @param {string} managedFolderName
* A fully-qualified path representing ManagedFolder resource.
* @returns {string} A string representing the project.
*/
matchProjectFromManagedFolderName(managedFolderName) {
return this.pathTemplates.managedFolderPathTemplate.match(managedFolderName).project;
}
/**
* Parse the bucket from ManagedFolder resource.
*
* @param {string} managedFolderName
* A fully-qualified path representing ManagedFolder resource.
* @returns {string} A string representing the bucket.
*/
matchBucketFromManagedFolderName(managedFolderName) {
return this.pathTemplates.managedFolderPathTemplate.match(managedFolderName).bucket;
}
/**
* Parse the managed_folder from ManagedFolder resource.
*
* @param {string} managedFolderName
* A fully-qualified path representing ManagedFolder resource.
* @returns {string} A string representing the managed_folder.
*/
matchManagedFolderFromManagedFolderName(managedFolderName) {
return this.pathTemplates.managedFolderPathTemplate.match(managedFolderName).managed_folder;
}
/**
* Return a fully-qualified orgLocationIntelligenceConfig resource name string.
*
* @param {string} org
* @param {string} location
* @returns {string} Resource name string.
*/
orgLocationIntelligenceConfigPath(org, location) {
return this.pathTemplates.orgLocationIntelligenceConfigPathTemplate.render({
org: org,
location: location,
});
}
/**
* Parse the org from OrgLocationIntelligenceConfig resource.
*
* @param {string} orgLocationIntelligenceConfigName
* A fully-qualified path representing org_location_intelligenceConfig resource.
* @returns {string} A string representing the org.
*/
matchOrgFromOrgLocationIntelligenceConfigName(orgLocationIntelligenceConfigName) {
return this.pathTemplates.orgLocationIntelligenceConfigPathTemplate.match(orgLocationIntelligenceConfigName).org;
}
/**
* Parse the location from OrgLocationIntelligenceConfig resource.
*
* @param {string} orgLocationIntelligenceConfigName
* A fully-qualified path representing org_location_intelligenceConfig resource.
* @returns {string} A string representing the location.
*/
matchLocationFromOrgLocationIntelligenceConfigName(orgLocationIntelligenceConfigName) {
return this.pathTemplates.orgLocationIntelligenceConfigPathTemplate.match(orgLocationIntelligenceConfigName).location;
}
/**
* 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;
}
/**
* Return a fully-qualified projectLocationIntelligenceConfig resource name string.
*
* @param {string} project
* @param {string} location
* @returns {string} Resource name string.
*/
projectLocationIntelligenceConfigPath(project, location) {
return this.pathTemplates.projectLocationIntelligenceConfigPathTemplate.render({
project: project,
location: location,
});
}
/**
* Parse the project from ProjectLocationIntelligenceConfig resource.
*
* @param {string} projectLocationIntelligenceConfigName
* A fully-qualified path representing project_location_intelligenceConfig resource.
* @returns {string} A string representing the project.
*/
matchProjectFromProjectLocationIntelligenceConfigName(projectLocationIntelligenceConfigName) {
return this.pathTemplates.projectLocationIntelligenceConfigPathTemplate.match(projectLocationIntelligenceConfigName).project;
}
/**
* Parse the location from ProjectLocationIntelligenceConfig resource.
*
* @param {string} projectLocationIntelligenceConfigName
* A fully-qualified path representing project_location_intelligenceConfig resource.
* @returns {string} A string representing the location.
*/
matchLocationFromProjectLocationIntelligenceConfigName(projectLocationIntelligenceConfigName) {
return this.pathTemplates.projectLocationIntelligenceConfigPathTemplate.match(projectLocationIntelligenceConfigName).location;
}
/**
* Return a fully-qualified storageLayout resource name string.
*
* @param {string} project
* @param {string} bucket
* @returns {string} Resource name string.
*/
storageLayoutPath(project, bucket) {
return this.pathTemplates.storageLayoutPathTemplate.render({
project: project,
bucket: bucket,
});
}
/**
* Parse the project from StorageLayout resource.
*
* @param {string} storageLayoutName
* A fully-qualified path representing StorageLayout resource.
* @returns {string} A string representing the project.
*/
matchProjectFromStorageLayoutName(storageLayoutName) {
return this.pathTemplates.storageLayoutPathTemplate.match(storageLayoutName).project;
}
/**
* Parse the bucket from StorageLayout resource.
*
* @param {string} storageLayoutName
* A fully-qualified path representing StorageLayout resource.
* @returns {string} A string representing the bucket.
*/
matchBucketFromStorageLayoutName(storageLayoutName) {
return this.pathTemplates.storageLayoutPathTemplate.match(storageLayoutName).bucket;
}
/**
* 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.storageControlStub && !this._terminated) {
return this.storageControlStub.then(stub => {
this._log.info('ending gRPC channel');
this._terminated = true;
stub.close();
void this.operationsClient.close();
});
}
return Promise.resolve();
}
}
exports.StorageControlClient = StorageControlClient;
//# sourceMappingURL=storage_control_client.js.map