@google-cloud/resource-manager
Version:
Cloud Resource Manager Client Library for Node.js
1,441 lines • 68.1 kB
JavaScript
"use strict";
// Copyright 2026 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.FoldersClient = void 0;
const jsonProtos = require("../../protos/protos.json");
const google_gax_1 = require("google-gax");
/**
* Client JSON configuration object, loaded from
* `src/v3/folders_client_config.json`.
* This file defines retry strategy and timeouts for all API methods in this library.
*/
const gapicConfig = require("./folders_client_config.json");
const version = require('../../../package.json').version;
/**
* Manages Cloud Platform folder resources.
* Folders can be used to organize the resources under an
* organization and to control the policies applied to groups of resources.
* @class
* @memberof v3
*/
class FoldersClient {
_terminated = false;
_opts;
_providedCustomServicePath;
_gaxModule;
_gaxGrpc;
_protos;
_defaults;
_universeDomain;
_servicePath;
_log = google_gax_1.loggingUtils.log('resource-manager');
auth;
descriptors = {
page: {},
stream: {},
longrunning: {},
batching: {},
};
warn;
innerApiCalls;
pathTemplates;
operationsClient;
foldersStub;
/**
* Construct an instance of FoldersClient.
*
* @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 FoldersClient({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 = 'cloudresourcemanager.' + 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 = {
folderPathTemplate: new this._gaxModule.PathTemplate('folders/{folder}'),
organizationPathTemplate: new this._gaxModule.PathTemplate('organizations/{organization}'),
projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
tagBindingPathTemplate: new this._gaxModule.PathTemplate('tagBindings/{tag_binding}'),
tagHoldPathTemplate: new this._gaxModule.PathTemplate('tagValues/{tag_value}/tagHolds/{tag_hold}'),
tagKeyPathTemplate: new this._gaxModule.PathTemplate('tagKeys/{tag_key}'),
tagValuePathTemplate: new this._gaxModule.PathTemplate('tagValues/{tag_value}'),
};
// 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'),
searchFolders: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'folders'),
};
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 = [
{
selector: 'google.longrunning.Operations.GetOperation',
get: '/v3/{name=operations/**}',
},
];
}
this.operationsClient = this._gaxModule
.lro(lroOptions)
.operationsClient(opts);
const createFolderResponse = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.Folder');
const createFolderMetadata = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.CreateFolderMetadata');
const updateFolderResponse = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.Folder');
const updateFolderMetadata = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.UpdateFolderMetadata');
const moveFolderResponse = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.Folder');
const moveFolderMetadata = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.MoveFolderMetadata');
const deleteFolderResponse = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.Folder');
const deleteFolderMetadata = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.DeleteFolderMetadata');
const undeleteFolderResponse = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.Folder');
const undeleteFolderMetadata = protoFilesRoot.lookup('.google.cloud.resourcemanager.v3.UndeleteFolderMetadata');
this.descriptors.longrunning = {
createFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createFolderResponse.decode.bind(createFolderResponse), createFolderMetadata.decode.bind(createFolderMetadata)),
updateFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, updateFolderResponse.decode.bind(updateFolderResponse), updateFolderMetadata.decode.bind(updateFolderMetadata)),
moveFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, moveFolderResponse.decode.bind(moveFolderResponse), moveFolderMetadata.decode.bind(moveFolderMetadata)),
deleteFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteFolderResponse.decode.bind(deleteFolderResponse), deleteFolderMetadata.decode.bind(deleteFolderMetadata)),
undeleteFolder: new this._gaxModule.LongrunningDescriptor(this.operationsClient, undeleteFolderResponse.decode.bind(undeleteFolderResponse), undeleteFolderMetadata.decode.bind(undeleteFolderMetadata)),
};
// Put together the default options sent with requests.
this._defaults = this._gaxGrpc.constructSettings('google.cloud.resourcemanager.v3.Folders', 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.foldersStub) {
return this.foldersStub;
}
// Put together the "service stub" for
// google.cloud.resourcemanager.v3.Folders.
this.foldersStub = this._gaxGrpc.createStub(this._opts.fallback
? this._protos.lookupService('google.cloud.resourcemanager.v3.Folders')
: // eslint-disable-next-line @typescript-eslint/no-explicit-any
this._protos.google.cloud.resourcemanager.v3.Folders, this._opts, this._providedCustomServicePath);
// Iterate over each of the methods that the service provides
// and create an API call method for each.
const foldersStubMethods = [
'getFolder',
'listFolders',
'searchFolders',
'createFolder',
'updateFolder',
'moveFolder',
'deleteFolder',
'undeleteFolder',
'getIamPolicy',
'setIamPolicy',
'testIamPermissions',
];
for (const methodName of foldersStubMethods) {
const callPromise = this.foldersStub.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.foldersStub;
}
/**
* 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 'cloudresourcemanager.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 'cloudresourcemanager.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',
];
}
/**
* 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();
}
getFolder(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('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;
});
}
getIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch((err) => {
throw err;
});
this._log.info('getIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('getIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.getIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('getIamPolicy response %j', response);
return [response, options, rawResponse];
})
.catch((error) => {
if (error &&
'statusDetails' in error &&
error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
setIamPolicy(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch((err) => {
throw err;
});
this._log.info('setIamPolicy request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('setIamPolicy response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.setIamPolicy(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('setIamPolicy response %j', response);
return [response, options, rawResponse];
})
.catch((error) => {
if (error &&
'statusDetails' in error &&
error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
testIamPermissions(request, optionsOrCallback, callback) {
request = request || {};
let options;
if (typeof optionsOrCallback === 'function' && callback === undefined) {
callback = optionsOrCallback;
options = {};
}
else {
options = optionsOrCallback;
}
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
options.otherArgs.headers['x-goog-request-params'] =
this._gaxModule.routingHeader.fromParams({
resource: request.resource ?? '',
});
this.initialize().catch((err) => {
throw err;
});
this._log.info('testIamPermissions request %j', request);
const wrappedCallback = callback
? (error, response, options, rawResponse) => {
this._log.info('testIamPermissions response %j', response);
callback(error, response, options, rawResponse); // We verified callback above.
}
: undefined;
return this.innerApiCalls
.testIamPermissions(request, options, wrappedCallback)
?.then(([response, options, rawResponse]) => {
this._log.info('testIamPermissions response %j', response);
return [response, options, rawResponse];
})
.catch((error) => {
if (error &&
'statusDetails' in error &&
error.statusDetails instanceof Array) {
const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
}
throw error;
});
}
createFolder(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 || {};
this.initialize().catch((err) => {
throw err;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('createFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('createFolder request %j', request);
return this.innerApiCalls
.createFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('createFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `createFolder()`.
* @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/v3/folders.create_folder.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_CreateFolder_async
*/
async checkCreateFolderProgress(name) {
this._log.info('createFolder 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.createFolder, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
updateFolder(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({
'folder.name': request.folder.name ?? '',
});
this.initialize().catch((err) => {
throw err;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('updateFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('updateFolder request %j', request);
return this.innerApiCalls
.updateFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('updateFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `updateFolder()`.
* @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/v3/folders.update_folder.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_UpdateFolder_async
*/
async checkUpdateFolderProgress(name) {
this._log.info('updateFolder 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.updateFolder, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
moveFolder(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;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('moveFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('moveFolder request %j', request);
return this.innerApiCalls
.moveFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('moveFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `moveFolder()`.
* @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/v3/folders.move_folder.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_MoveFolder_async
*/
async checkMoveFolderProgress(name) {
this._log.info('moveFolder 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.moveFolder, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
deleteFolder(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;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('deleteFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('deleteFolder request %j', request);
return this.innerApiCalls
.deleteFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('deleteFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `deleteFolder()`.
* @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/v3/folders.delete_folder.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_DeleteFolder_async
*/
async checkDeleteFolderProgress(name) {
this._log.info('deleteFolder 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.deleteFolder, this._gaxModule.createDefaultBackoffSettings());
return decodeOperation;
}
undeleteFolder(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;
});
const wrappedCallback = callback
? (error, response, rawResponse, _) => {
this._log.info('undeleteFolder response %j', rawResponse);
callback(error, response, rawResponse, _); // We verified callback above.
}
: undefined;
this._log.info('undeleteFolder request %j', request);
return this.innerApiCalls
.undeleteFolder(request, options, wrappedCallback)
?.then(([response, rawResponse, _]) => {
this._log.info('undeleteFolder response %j', rawResponse);
return [response, rawResponse, _];
});
}
/**
* Check the status of the long running operation returned by `undeleteFolder()`.
* @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/v3/folders.undelete_folder.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_UndeleteFolder_async
*/
async checkUndeleteFolderProgress(name) {
this._log.info('undeleteFolder 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.undeleteFolder, 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 || {};
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. The name of the parent resource whose folders are being listed.
* Only children of this parent resource are listed; descendants are not
* listed.
*
* If the parent is a folder, use the value `folders/{folder_id}`. If the
* parent is an organization, use the value `organizations/{org_id}`.
*
* Access to this method is controlled by checking the
* `resourcemanager.folders.list` permission on the `parent`.
* @param {number} [request.pageSize]
* Optional. The maximum number of folders to return in the response. The
* server can return fewer folders than requested. If unspecified, server
* picks an appropriate default.
* @param {string} [request.pageToken]
* Optional. A pagination token returned from a previous call to `ListFolders`
* that indicates where this listing should continue from.
* @param {boolean} [request.showDeleted]
* Optional. Controls whether folders in the
* {@link protos.google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED|DELETE_REQUESTED}
* state should be returned. Defaults to false.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.resourcemanager.v3.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 || {};
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. The name of the parent resource whose folders are being listed.
* Only children of this parent resource are listed; descendants are not
* listed.
*
* If the parent is a folder, use the value `folders/{folder_id}`. If the
* parent is an organization, use the value `organizations/{org_id}`.
*
* Access to this method is controlled by checking the
* `resourcemanager.folders.list` permission on the `parent`.
* @param {number} [request.pageSize]
* Optional. The maximum number of folders to return in the response. The
* server can return fewer folders than requested. If unspecified, server
* picks an appropriate default.
* @param {string} [request.pageToken]
* Optional. A pagination token returned from a previous call to `ListFolders`
* that indicates where this listing should continue from.
* @param {boolean} [request.showDeleted]
* Optional. Controls whether folders in the
* {@link protos.google.cloud.resourcemanager.v3.Folder.State.DELETE_REQUESTED|DELETE_REQUESTED}
* state should be returned. Defaults to false.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.resourcemanager.v3.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/v3/folders.list_folders.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_ListFolders_async
*/
listFoldersAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
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);
}
searchFolders(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 || {};
this.initialize().catch((err) => {
throw err;
});
const wrappedCallback = callback
? (error, values, nextPageRequest, rawResponse) => {
this._log.info('searchFolders values %j', values);
callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
}
: undefined;
this._log.info('searchFolders request %j', request);
return this.innerApiCalls
.searchFolders(request, options, wrappedCallback)
?.then(([response, input, output]) => {
this._log.info('searchFolders values %j', response);
return [response, input, output];
});
}
/**
* Equivalent to `searchFolders`, but returns a NodeJS Stream object.
* @param {Object} request
* The request object that will be sent.
* @param {number} [request.pageSize]
* Optional. The maximum number of folders to return in the response. The
* server can return fewer folders than requested. If unspecified, server
* picks an appropriate default.
* @param {string} [request.pageToken]
* Optional. A pagination token returned from a previous call to
* `SearchFolders` that indicates from where search should continue.
* @param {string} [request.query]
* Optional. Search criteria used to select the folders to return.
* If no search criteria is specified then all accessible folders will be
* returned.
*
* Query expressions can be used to restrict results based upon displayName,
* state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
* can be used along with the suffix wildcard symbol `*`.
*
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
*
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
*
* Some example queries are:
*
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
* * Query `state=ACTIVE` returns Folder resources with
* `state` set to `ACTIVE`.
* * Query `parent=folders/123` returns Folder resources that have
* `folders/123` as a parent resource.
* * Query `parent=folders/123 AND state=ACTIVE` returns active
* Folder resources that have `folders/123` as a parent resource.
* * Query `displayName=\\"Test String\\"` returns Folder resources with
* display names that include both "Test" and "String".
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Stream}
* An object stream which emits an object representing {@link protos.google.cloud.resourcemanager.v3.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 `searchFoldersAsync()`
* 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.
*/
searchFoldersStream(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
const defaultCallSettings = this._defaults['searchFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch((err) => {
throw err;
});
this._log.info('searchFolders stream %j', request);
return this.descriptors.page.searchFolders.createStream(this.innerApiCalls.searchFolders, request, callSettings);
}
/**
* Equivalent to `searchFolders`, 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 {number} [request.pageSize]
* Optional. The maximum number of folders to return in the response. The
* server can return fewer folders than requested. If unspecified, server
* picks an appropriate default.
* @param {string} [request.pageToken]
* Optional. A pagination token returned from a previous call to
* `SearchFolders` that indicates from where search should continue.
* @param {string} [request.query]
* Optional. Search criteria used to select the folders to return.
* If no search criteria is specified then all accessible folders will be
* returned.
*
* Query expressions can be used to restrict results based upon displayName,
* state and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`
* can be used along with the suffix wildcard symbol `*`.
*
* The `displayName` field in a query expression should use escaped quotes
* for values that include whitespace to prevent unexpected behavior.
*
* ```
* | Field | Description |
* |-------------------------|----------------------------------------|
* | displayName | Filters by displayName. |
* | parent | Filters by parent (for example: folders/123). |
* | state, lifecycleState | Filters by state. |
* ```
*
* Some example queries are:
*
* * Query `displayName=Test*` returns Folder resources whose display name
* starts with "Test".
* * Query `state=ACTIVE` returns Folder resources with
* `state` set to `ACTIVE`.
* * Query `parent=folders/123` returns Folder resources that have
* `folders/123` as a parent resource.
* * Query `parent=folders/123 AND state=ACTIVE` returns active
* Folder resources that have `folders/123` as a parent resource.
* * Query `displayName=\\"Test String\\"` returns Folder resources with
* display names that include both "Test" and "String".
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Object}
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
* When you iterate the returned iterable, each element will be an object representing
* {@link protos.google.cloud.resourcemanager.v3.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/v3/folders.search_folders.js</caption>
* region_tag:cloudresourcemanager_v3_generated_Folders_SearchFolders_async
*/
searchFoldersAsync(request, options) {
request = request || {};
options = options || {};
options.otherArgs = options.otherArgs || {};
options.otherArgs.headers = options.otherArgs.headers || {};
const defaultCallSettings = this._defaults['searchFolders'];
const callSettings = defaultCallSettings.merge(options);
this.initialize().catch((err) => {
throw err;
});
this._log.info('searchFolders iterate %j', request);
return this.descriptors.page.searchFolders.asyncIterate(this.innerApiCalls['searchFolders'], 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 folder resource name string.
*
* @param {string} folder
* @returns {string} Resource name string.
*/
folderPath(folder) {
return this.pathTemplates.folderPathTemplate.render({
folder: folder,
});
}
/**
* 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 organization resource name string.
*
* @param {string} organization
* @returns {string} Resource name string.
*/
organizationPath(organization) {
return this.pathTemplates.organizationPathTemplate.render({
organization: organization,
});
}
/**
* Parse the organization from Organization resource.
*
* @param {string} organizationName
* A fully-qualified path representing Organization resource.
* @returns {string} A string representing the organization.
*/
matchOrganizationFromOrganizationName(organizationName) {
return this.pathTemplates.organizationPathTemplate.match(organizationName)
.organization;
}
/**
* 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 tagBinding resource name string.
*
* @param {string} tag_binding
* @returns {string} Resource name string.
*/
tagBindingPath(tagBinding) {
return this.pathTemplates.tagBindingPathTemplate.render({
tag_binding: tagBinding,
});
}
/**
* Parse the tag_binding from TagBinding resource.
*
* @param {string} tagBindingName
* A fully-qualified path representing TagBinding resource.
* @returns {string} A string representing the tag_binding.
*/
matchTagBindingFromTagBindingName(tagBindingName) {
return this.pathTemplates.tagBindingPathTemplate.match(tagBindingName)
.tag_binding;
}
/**
* Return a fully-qualified tagHold resource name string.
*
* @param {string} tag_value
* @param {string} tag_hold
* @returns {string} Resource name string.
*/
tagHoldPath(tagValue, tagHold) {
return this.pathTemplates.tagHoldPathTemplate.render({
tag_value: tagValue,
tag_hold: tagHold,
});
}
/**
* Parse the tag_value from TagHold resource.
*
* @param {string} tagHoldName
* A fully-qualified path representing TagHold resource.
* @returns {string} A string representing the tag_value.
*/
matchTagValueFromTagHoldName(tagHoldName) {
return this.pathTemplates.tagHoldPathTemplate.match(tagHoldName).tag_value;
}
/**
* Parse the tag_hold from TagHold resource.
*
* @param {string} tagHoldName
* A fully-qualified path representing TagHold resource.
* @returns {string} A string representing the tag_hold.
*/
matchTagHoldFromTagHoldName(tagHoldName) {
return this.pathTemplates.tagHoldPathTemplate.match(tagHoldName).tag_hold;
}
/**
* Return a fully-qualified tagKey resource name string.
*
* @param {string} tag_key
* @returns {string} Resource name string.
*/
tagKeyPath(tagKey) {
return this.pathTemplates.tagKeyPathTemplate.render({
tag_key: tagKey,
});
}
/**
* Parse the tag_key from TagKey resource.
*
* @param {string} tagKeyName
* A fully-qualified path representing TagKey resource.
* @returns {string} A string representing the tag_key.
*/
matchTagKeyFromTagKeyName(tagKeyName) {
return this.pathTemplates.tagKeyPathTemplate.match(tagKeyName).tag_key;
}
/**
* Return a fully-qualified tagValue resource name string.
*
* @param {string} tag_value
* @returns {string} Resource name string.
*/
tagValuePath(tagValue) {
return this.pathTemplates.tagValuePathTemplate.render({
tag_value: tagValue,
});
}
/**
* Parse the tag_value from TagValue resource.
*
* @param {string} tagValueName
* A fully-qualified path representing TagValue resource.
* @returns {string} A string representing the tag_value.
*/
matchTagValueFromTagValueName(tagValueName) {
return this.pathTemplates.tagValuePathTemplate.match(tagValueName)
.tag_value;
}
/**
* 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.foldersStub && !this._terminated) {
return this.foldersStub.then((stub) => {
this._log.info('ending gRPC channel');
this._terminated = true;
stub.close();
void this.operationsClient.close();
});
}
return Promise.resolve();
}
}
exports.FoldersClient = FoldersClient;
//# sourceMappingURL=folders_client.js.map