import { protos } from './'; import { StorageControlClient as StorageControlInternal } from './v2/storage_control_client'; import { StorageClient } from './v2/storage_client'; import type * as gax from 'google-gax'; import { Callback, CallOptions, ClientOptions, PaginationCallback, LROperation, Descriptors } from 'google-gax'; import { Transform } from 'stream'; /** * Options passed to the underlying client. * * @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); * ``` */ export interface StorageControlClientOptions extends ClientOptions { gaxInstance?: typeof gax | typeof gax.fallback; storageControlInternal?: StorageControlInternal; storageClient?: StorageClient; } export declare class StorageControlClient { storageControlInternal: StorageControlInternal; storageClient: StorageClient; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; storageControlStub?: Promise<{ [name: string]: Function; }>; /** * @param {object} [StorageControlClientOptions] - Enables user to instantiate clients separately and use those as the subclients. * To have sub-clients with different options, instantiate each client separately. */ constructor(options?: StorageControlClientOptions); /** * 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(): Promise<{ [name: string]: Function; }>; /** * 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(): string; /** * 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(): string; /** * 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. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(callback?: Callback): Promise | void; /** * Creates a new folder. This operation is only applicable to a hierarchical * namespace enabled bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. Name of the bucket in which the folder will reside. The bucket * must be a hierarchical namespace enabled bucket. * @param {google.storage.control.v2.Folder} request.folder * Required. Properties of the new folder being created. * The bucket and name of the folder are specified in the parent and folder_id * fields, respectively. Populating those fields in `folder` will result in an * error. * @param {string} request.folderId * Required. The full name of a folder, including all its parent folders. * Folders use single '/' characters as a delimiter. * The folder_id must end with a slash. * For example, the folder_id of "books/biographies/" would create a new * "biographies/" folder under the "books/" folder. * @param {boolean} [request.recursive] * Optional. If true, parent folder doesn't have to be present and all missing * ancestor folders will be created atomically. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.Folder|Folder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.create_folder.js * region_tag:storage_v2_generated_StorageControl_CreateFolder_async */ createFolder(request?: protos.google.storage.control.v2.ICreateFolderRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.ICreateFolderRequest | undefined, {} | undefined ]>; createFolder(request: protos.google.storage.control.v2.ICreateFolderRequest, options: CallOptions, callback: Callback): void; createFolder(request: protos.google.storage.control.v2.ICreateFolderRequest, callback: Callback): void; /** * Permanently deletes an empty folder. This operation is only applicable to a * hierarchical namespace enabled bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the folder. * Format: `projects/{project}/buckets/{bucket}/folders/{folder}` * @param {number} request.ifMetagenerationMatch * Makes the operation only succeed conditional on whether the folder's * current metageneration matches the given value. * @param {number} request.ifMetagenerationNotMatch * Makes the operation only succeed conditional on whether the folder's * current metageneration does not match the given value. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.delete_folder.js * region_tag:storage_v2_generated_StorageControl_DeleteFolder_async */ deleteFolder(request?: protos.google.storage.control.v2.IDeleteFolderRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteFolderRequest | undefined, {} | undefined ]>; deleteFolder(request: protos.google.storage.control.v2.IDeleteFolderRequest, options: CallOptions, callback: Callback): void; deleteFolder(request: protos.google.storage.control.v2.IDeleteFolderRequest, callback: Callback): void; /** * Returns metadata for the specified folder. This operation is only * applicable to a hierarchical namespace enabled bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the folder. * Format: `projects/{project}/buckets/{bucket}/folders/{folder}` * @param {number} request.ifMetagenerationMatch * Makes the operation only succeed conditional on whether the folder's * current metageneration matches the given value. * @param {number} request.ifMetagenerationNotMatch * Makes the operation only succeed conditional on whether the folder's * current metageneration does not match the given value. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.Folder|Folder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_folder.js * region_tag:storage_v2_generated_StorageControl_GetFolder_async */ getFolder(request?: protos.google.storage.control.v2.IGetFolderRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IGetFolderRequest | undefined, {} | undefined ]>; getFolder(request: protos.google.storage.control.v2.IGetFolderRequest, options: CallOptions, callback: Callback): void; getFolder(request: protos.google.storage.control.v2.IGetFolderRequest, callback: Callback): void; /** * Returns the storage layout configuration for a given bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the StorageLayout resource. * Format: `projects/{project}/buckets/{bucket}/storageLayout` * @param {string} request.prefix * An optional prefix used for permission check. It is useful when the caller * only has limited permissions under a specific 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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.StorageLayout|StorageLayout}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_storage_layout.js * region_tag:storage_v2_generated_StorageControl_GetStorageLayout_async */ getStorageLayout(request?: protos.google.storage.control.v2.IGetStorageLayoutRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IStorageLayout, protos.google.storage.control.v2.IGetStorageLayoutRequest | undefined, {} | undefined ]>; getStorageLayout(request: protos.google.storage.control.v2.IGetStorageLayoutRequest, options: CallOptions, callback: Callback): void; getStorageLayout(request: protos.google.storage.control.v2.IGetStorageLayoutRequest, callback: Callback): void; /** * Creates a new managed folder. * * @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 {google.storage.control.v2.ManagedFolder} request.managedFolder * Required. Properties of the managed folder being created. * The bucket and managed folder names are specified in the `parent` and * `managed_folder_id` fields. Populating these fields in `managed_folder` * will result in an error. * @param {string} request.managedFolderId * Required. The name of the managed folder. It uses a single `/` as delimiter * and leading and trailing `/` are allowed. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.ManagedFolder|ManagedFolder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.create_managed_folder.js * region_tag:storage_v2_generated_StorageControl_CreateManagedFolder_async */ createManagedFolder(request?: protos.google.storage.control.v2.ICreateManagedFolderRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.ICreateManagedFolderRequest | undefined, {} | undefined ]>; createManagedFolder(request: protos.google.storage.control.v2.ICreateManagedFolderRequest, options: CallOptions, callback: Callback): void; createManagedFolder(request: protos.google.storage.control.v2.ICreateManagedFolderRequest, callback: Callback): void; /** * Permanently deletes an empty managed folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the managed folder. * Format: * `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}` * @param {number} request.ifMetagenerationMatch * The operation succeeds conditional on the managed folder's current * metageneration matching the value here specified. * @param {number} request.ifMetagenerationNotMatch * The operation succeeds conditional on the managed folder's current * metageneration NOT matching the value here specified. * @param {boolean} request.allowNonEmpty * Allows deletion of a managed folder even if it is not empty. * A managed folder is empty if it manages no child managed folders or * objects. Caller must have permission for * storage.managedFolders.setIamPolicy. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.delete_managed_folder.js * region_tag:storage_v2_generated_StorageControl_DeleteManagedFolder_async */ deleteManagedFolder(request?: protos.google.storage.control.v2.IDeleteManagedFolderRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteManagedFolderRequest | undefined, {} | undefined ]>; deleteManagedFolder(request: protos.google.storage.control.v2.IDeleteManagedFolderRequest, options: CallOptions, callback: Callback): void; deleteManagedFolder(request: protos.google.storage.control.v2.IDeleteManagedFolderRequest, callback: Callback): void; /** * Returns metadata for the specified managed folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the managed folder. * Format: * `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}` * @param {number} request.ifMetagenerationMatch * The operation succeeds conditional on the managed folder's current * metageneration matching the value here specified. * @param {number} request.ifMetagenerationNotMatch * The operation succeeds conditional on the managed folder's current * metageneration NOT matching the value here specified. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.ManagedFolder|ManagedFolder}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_managed_folder.js * region_tag:storage_v2_generated_StorageControl_GetManagedFolder_async */ getManagedFolder(request?: protos.google.storage.control.v2.IGetManagedFolderRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.IGetManagedFolderRequest | undefined, {} | undefined ]>; getManagedFolder(request: protos.google.storage.control.v2.IGetManagedFolderRequest, options: CallOptions, callback: Callback): void; getManagedFolder(request: protos.google.storage.control.v2.IGetManagedFolderRequest, callback: Callback): void; /** * Disables an Anywhere Cache instance. A disabled instance is read-only. The * disablement could be revoked by calling ResumeAnywhereCache. The cache * instance will be deleted automatically if it remains in the disabled state * for at least one hour. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name field in the request should be: * `projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}` * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.AnywhereCache|AnywhereCache}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.disable_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_DisableAnywhereCache_async */ disableAnywhereCache(request?: protos.google.storage.control.v2.IDisableAnywhereCacheRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IDisableAnywhereCacheRequest | undefined, {} | undefined ]>; disableAnywhereCache(request: protos.google.storage.control.v2.IDisableAnywhereCacheRequest, options: CallOptions, callback: Callback): void; disableAnywhereCache(request: protos.google.storage.control.v2.IDisableAnywhereCacheRequest, callback: Callback): void; /** * Pauses an Anywhere Cache instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name field in the request should be: * `projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}` * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.AnywhereCache|AnywhereCache}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.pause_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_PauseAnywhereCache_async */ pauseAnywhereCache(request?: protos.google.storage.control.v2.IPauseAnywhereCacheRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IPauseAnywhereCacheRequest | undefined, {} | undefined ]>; pauseAnywhereCache(request: protos.google.storage.control.v2.IPauseAnywhereCacheRequest, options: CallOptions, callback: Callback): void; pauseAnywhereCache(request: protos.google.storage.control.v2.IPauseAnywhereCacheRequest, callback: Callback): void; /** * Resumes a disabled or paused Anywhere Cache instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name field in the request should be: * `projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}` * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.AnywhereCache|AnywhereCache}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.resume_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_ResumeAnywhereCache_async */ resumeAnywhereCache(request?: protos.google.storage.control.v2.IResumeAnywhereCacheRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IResumeAnywhereCacheRequest | undefined, {} | undefined ]>; resumeAnywhereCache(request: protos.google.storage.control.v2.IResumeAnywhereCacheRequest, options: CallOptions, callback: Callback): void; resumeAnywhereCache(request: protos.google.storage.control.v2.IResumeAnywhereCacheRequest, callback: Callback): void; /** * Gets an Anywhere Cache instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name field in the request should be: * `projects/{project}/buckets/{bucket}/anywhereCaches/{anywhere_cache}` * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.AnywhereCache|AnywhereCache}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_GetAnywhereCache_async */ getAnywhereCache(request?: protos.google.storage.control.v2.IGetAnywhereCacheRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IGetAnywhereCacheRequest | undefined, {} | undefined ]>; getAnywhereCache(request: protos.google.storage.control.v2.IGetAnywhereCacheRequest, options: CallOptions, callback: Callback): void; getAnywhereCache(request: protos.google.storage.control.v2.IGetAnywhereCacheRequest, callback: Callback): void; /** * Returns the Project scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the `IntelligenceConfig` resource associated with * your project. * * Format: `projects/{id}/locations/global/intelligenceConfig` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_project_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_GetProjectIntelligenceConfig_async */ getProjectIntelligenceConfig(request?: protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest | undefined), {} | undefined ]>; getProjectIntelligenceConfig(request: protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; getProjectIntelligenceConfig(request: protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest, callback: Callback): void; /** * Updates the Project scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {google.storage.control.v2.IntelligenceConfig} request.intelligenceConfig * Required. The `IntelligenceConfig` resource to be updated. * @param {google.protobuf.FieldMask} request.updateMask * Required. The `update_mask` that specifies the fields within the * `IntelligenceConfig` resource that should be modified by this update. Only * the listed fields are updated. * @param {string} [request.requestId] * Optional. The ID that uniquely identifies the request, preventing duplicate * processing. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.update_project_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_UpdateProjectIntelligenceConfig_async */ updateProjectIntelligenceConfig(request?: protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest | undefined), {} | undefined ]>; updateProjectIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; updateProjectIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest, callback: Callback): void; /** * Returns the Folder scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the `IntelligenceConfig` resource associated with * your folder. * * Format: `folders/{id}/locations/global/intelligenceConfig` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_folder_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_GetFolderIntelligenceConfig_async */ getFolderIntelligenceConfig(request?: protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest | undefined), {} | undefined ]>; getFolderIntelligenceConfig(request: protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; getFolderIntelligenceConfig(request: protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest, callback: Callback): void; /** * Updates the Folder scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {google.storage.control.v2.IntelligenceConfig} request.intelligenceConfig * Required. The `IntelligenceConfig` resource to be updated. * @param {google.protobuf.FieldMask} request.updateMask * Required. The `update_mask` that specifies the fields within the * `IntelligenceConfig` resource that should be modified by this update. Only * the listed fields are updated. * @param {string} [request.requestId] * Optional. The ID that uniquely identifies the request, preventing duplicate * processing. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.update_folder_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_UpdateFolderIntelligenceConfig_async */ updateFolderIntelligenceConfig(request?: protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest | undefined), {} | undefined ]>; updateFolderIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; updateFolderIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest, callback: Callback): void; /** * Returns the Organization scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the `IntelligenceConfig` resource associated with * your organization. * * Format: `organizations/{org_id}/locations/global/intelligenceConfig` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_organization_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_GetOrganizationIntelligenceConfig_async */ getOrganizationIntelligenceConfig(request?: protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest | undefined), {} | undefined ]>; getOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; getOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest, callback: Callback): void; /** * Updates the Organization scoped singleton IntelligenceConfig resource. * * @param {Object} request * The request object that will be sent. * @param {google.storage.control.v2.IntelligenceConfig} request.intelligenceConfig * Required. The `IntelligenceConfig` resource to be updated. * @param {google.protobuf.FieldMask} request.updateMask * Required. The `update_mask` that specifies the fields within the * `IntelligenceConfig` resource that should be modified by this update. Only * the listed fields are updated. * @param {string} [request.requestId] * Optional. The ID that uniquely identifies the request, preventing duplicate * processing. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.control.v2.IntelligenceConfig|IntelligenceConfig}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.update_organization_intelligence_config.js * region_tag:storage_v2_generated_StorageControl_UpdateOrganizationIntelligenceConfig_async */ updateOrganizationIntelligenceConfig(request?: protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IIntelligenceConfig, (protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest | undefined), {} | undefined ]>; updateOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest, options: CallOptions, callback: Callback): void; updateOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest, callback: Callback): void; /** * Gets the IAM policy for a specified bucket. * The `resource` field in the request should be * `projects/_/buckets/{bucket}` for a bucket, or * `projects/_/buckets/{bucket}/managedFolders/{managedFolder}` * for a managed folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.GetPolicyOptions} request.options * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.get_iam_policy.js * region_tag:storage_v2_generated_StorageControl_GetIamPolicy_async */ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback): void; /** * Updates an IAM policy for the specified bucket. * The `resource` field in the request should be * `projects/_/buckets/{bucket}` for a bucket, or * `projects/_/buckets/{bucket}/managedFolders/{managedFolder}` * for a managed folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being specified. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.Policy} request.policy * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a * valid policy but certain Cloud Platform services (such as Projects) * might reject them. * @param {google.protobuf.FieldMask} request.updateMask * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only * the fields in the mask will be modified. If no mask is provided, the * following default mask is used: * * `paths: "bindings, etag"` * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.set_iam_policy.js * region_tag:storage_v2_generated_StorageControl_SetIamPolicy_async */ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback): void; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback): void; /** * Tests a set of permissions on the given bucket, object, or managed folder * to see which, if any, are held by the caller. * The `resource` field in the request should be * `projects/_/buckets/{bucket}` for a bucket, * `projects/_/buckets/{bucket}/objects/{object}` for an object, or * `projects/_/buckets/{bucket}/managedFolders/{managedFolder}` * for a managed folder. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage_control.test_iam_permissions.js * region_tag:storage_v2_generated_StorageControl_TestIamPermissions_async */ testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback): void; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback): void; /** * Renames a source folder to a destination folder. This operation is only * applicable to a hierarchical namespace enabled bucket. During a rename, the * source and destination folders are locked until the long running operation * completes. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the source folder being renamed. * Format: `projects/{project}/buckets/{bucket}/folders/{folder}` * @param {string} request.destinationFolderId * Required. The destination folder ID, e.g. `foo/bar/`. * @param {number} request.ifMetagenerationMatch * Makes the operation only succeed conditional on whether the source * folder's current metageneration matches the given value. * @param {number} request.ifMetagenerationNotMatch * Makes the operation only succeed conditional on whether the source * folder's current metageneration does not match the given value. * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * 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 include:samples/generated/v2/storage_control.rename_folder.js * region_tag:storage_v2_generated_StorageControl_RenameFolder_async */ renameFolder(request?: protos.google.storage.control.v2.IRenameFolderRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; renameFolder(request: protos.google.storage.control.v2.IRenameFolderRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; renameFolder(request: protos.google.storage.control.v2.IRenameFolderRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * 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 include:samples/generated/v2/storage_control.rename_folder.js * region_tag:storage_v2_generated_StorageControl_RenameFolder_async */ checkRenameFolderProgress(name: string): Promise>; /** * Deletes a folder recursively. This operation is only applicable to a * hierarchical namespace enabled bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of the folder being deleted, however all of its contents * will be deleted too. Format: * `projects/{project}/buckets/{bucket}/folders/{folder}` * @param {number} [request.ifMetagenerationMatch] * Optional. Makes the operation only succeed conditional on whether the root * folder's current metageneration matches the given value. * @param {number} [request.ifMetagenerationNotMatch] * Optional. Makes the operation only succeed conditional on whether the root * folder's current metageneration does not match the given value. * @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 {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * 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 include:samples/generated/v2/storage_control.delete_folder_recursive.js * region_tag:storage_v2_generated_StorageControl_DeleteFolderRecursive_async */ deleteFolderRecursive(request?: protos.google.storage.control.v2.IDeleteFolderRecursiveRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteFolderRecursive(request: protos.google.storage.control.v2.IDeleteFolderRecursiveRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteFolderRecursive(request: protos.google.storage.control.v2.IDeleteFolderRecursiveRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteFolderRecursive()`. * @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 include:samples/generated/v2/storage_control.delete_folder_recursive.js * region_tag:storage_v2_generated_StorageControl_DeleteFolderRecursive_async */ checkDeleteFolderRecursiveProgress(name: string): Promise>; /** * Creates an Anywhere Cache instance. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The bucket to which this cache belongs. * Format: `projects/{project}/buckets/{bucket}` * @param {google.storage.control.v2.AnywhereCache} request.anywhereCache * Required. Properties of the Anywhere Cache instance being created. * The parent bucket name is specified in the `parent` field. Server uses the * default value of `ttl` or `admission_policy` if not specified in * request. * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * 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 include:samples/generated/v2/storage_control.create_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_CreateAnywhereCache_async */ createAnywhereCache(request?: protos.google.storage.control.v2.ICreateAnywhereCacheRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createAnywhereCache(request: protos.google.storage.control.v2.ICreateAnywhereCacheRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createAnywhereCache(request: protos.google.storage.control.v2.ICreateAnywhereCacheRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * 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 include:samples/generated/v2/storage_control.create_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_CreateAnywhereCache_async */ checkCreateAnywhereCacheProgress(name: string): Promise>; /** * Updates an Anywhere Cache instance. Mutable fields include `ttl` and * `admission_policy`. * * @param {Object} request * The request object that will be sent. * @param {google.storage.control.v2.AnywhereCache} request.anywhereCache * Required. The Anywhere Cache instance to be updated. * @param {google.protobuf.FieldMask} request.updateMask * Required. List of fields to be updated. Mutable fields of AnywhereCache * include `ttl` and `admission_policy`. * * To specify ALL fields, specify a single field with the value `*`. Note: We * recommend against doing this. If a new field is introduced at a later time, * an older client updating with the `*` may accidentally reset the new * field's value. * * Not specifying any fields is an error. * @param {string} [request.requestId] * Optional. A unique identifier for this request. UUID is the recommended * format, but other formats are still accepted. This request is only * idempotent if a `request_id` is provided. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * a long running operation. Its `promise()` method returns a promise * you can `await` for. * 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 include:samples/generated/v2/storage_control.update_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_UpdateAnywhereCache_async */ updateAnywhereCache(request?: protos.google.storage.control.v2.IUpdateAnywhereCacheRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateAnywhereCache(request: protos.google.storage.control.v2.IUpdateAnywhereCacheRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateAnywhereCache(request: protos.google.storage.control.v2.IUpdateAnywhereCacheRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * 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 include:samples/generated/v2/storage_control.update_anywhere_cache.js * region_tag:storage_v2_generated_StorageControl_UpdateAnywhereCache_async */ checkUpdateAnywhereCacheProgress(name: string): Promise>; /** * Retrieves a list of folders. This operation is only applicable to a * hierarchical namespace enabled bucket. * * @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 {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.storage.control.v2.Folder|Folder}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * 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. */ listFolders(request?: protos.google.storage.control.v2.IListFoldersRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IFolder[], protos.google.storage.control.v2.IListFoldersRequest | null, protos.google.storage.control.v2.IListFoldersResponse ]>; listFolders(request: protos.google.storage.control.v2.IListFoldersRequest, options: CallOptions, callback: PaginationCallback): void; listFolders(request: protos.google.storage.control.v2.IListFoldersRequest, callback: PaginationCallback): void; /** * 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?: protos.google.storage.control.v2.IListFoldersRequest, options?: CallOptions): Transform; /** * 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 include:samples/generated/v2/storage_control.list_folders.js * region_tag:storage_v2_generated_StorageControl_ListFolders_async */ listFoldersAsync(request?: protos.google.storage.control.v2.IListFoldersRequest, options?: CallOptions): AsyncIterable; /** * Retrieves a list of managed folders for a given bucket. * * @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 {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.storage.control.v2.ManagedFolder|ManagedFolder}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * 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. */ listManagedFolders(request?: protos.google.storage.control.v2.IListManagedFoldersRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IManagedFolder[], protos.google.storage.control.v2.IListManagedFoldersRequest | null, protos.google.storage.control.v2.IListManagedFoldersResponse ]>; listManagedFolders(request: protos.google.storage.control.v2.IListManagedFoldersRequest, options: CallOptions, callback: PaginationCallback): void; listManagedFolders(request: protos.google.storage.control.v2.IListManagedFoldersRequest, callback: PaginationCallback): void; /** * 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?: protos.google.storage.control.v2.IListManagedFoldersRequest, options?: CallOptions): Transform; /** * 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 include:samples/generated/v2/storage_control.list_managed_folders.js * region_tag:storage_v2_generated_StorageControl_ListManagedFolders_async */ listManagedFoldersAsync(request?: protos.google.storage.control.v2.IListManagedFoldersRequest, options?: CallOptions): AsyncIterable; /** * Lists Anywhere Cache instances for a given bucket. * * @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 {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.storage.control.v2.AnywhereCache|AnywhereCache}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * 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. */ listAnywhereCaches(request?: protos.google.storage.control.v2.IListAnywhereCachesRequest, options?: CallOptions): Promise<[ protos.google.storage.control.v2.IAnywhereCache[], protos.google.storage.control.v2.IListAnywhereCachesRequest | null, protos.google.storage.control.v2.IListAnywhereCachesResponse ]>; listAnywhereCaches(request: protos.google.storage.control.v2.IListAnywhereCachesRequest, options: CallOptions, callback: PaginationCallback): void; listAnywhereCaches(request: protos.google.storage.control.v2.IListAnywhereCachesRequest, callback: PaginationCallback): void; /** * 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?: protos.google.storage.control.v2.IListAnywhereCachesRequest, options?: CallOptions): Transform; /** * 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 include:samples/generated/v2/storage_control.list_anywhere_caches.js * region_tag:storage_v2_generated_StorageControl_ListAnywhereCaches_async */ listAnywhereCachesAsync(request?: protos.google.storage.control.v2.IListAnywhereCachesRequest, options?: CallOptions): AsyncIterable; /** * 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?: protos.google.longrunning.GetOperationRequest, options?: CallOptions): Promise<[protos.google.longrunning.Operation]>; getOperation(request: protos.google.longrunning.GetOperationRequest, options: CallOptions, callback: Callback): void; getOperation(request: protos.google.longrunning.GetOperationRequest, callback: Callback): void; /** * 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: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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?: protos.google.longrunning.CancelOperationRequest, options?: CallOptions): Promise; cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options: CallOptions, callback: Callback): void; cancelOperation(request: protos.google.longrunning.CancelOperationRequest, callback: Callback): void; /** * 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?: protos.google.longrunning.DeleteOperationRequest, options?: CallOptions): Promise; deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options: CallOptions, callback: Callback): void; deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, callback: Callback): void; /** * 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: string, bucket: string, anywhereCache: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified bucket resource name string. * * @param {string} project * @param {string} bucket * @returns {string} Resource name string. */ bucketPath(project: string, bucket: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified folder resource name string. * * @param {string} project * @param {string} bucket * @param {string} folder * @returns {string} Resource name string. */ folderPath(project: string, bucket: string, folder: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified folderLocationIntelligenceConfig resource name string. * * @param {string} folder * @param {string} location * @returns {string} Resource name string. */ folderLocationIntelligenceConfigPath(folder: string, location: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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: string, bucket: string, managedFolder: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified orgLocationIntelligenceConfig resource name string. * * @param {string} org * @param {string} location * @returns {string} Resource name string. */ orgLocationIntelligenceConfigPath(org: string, location: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified project resource name string. * * @param {string} project * @returns {string} Resource name string. */ projectPath(project: string): string; /** * 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: string): string | number; /** * Return a fully-qualified projectLocationIntelligenceConfig resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ projectLocationIntelligenceConfigPath(project: string, location: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * Return a fully-qualified storageLayout resource name string. * * @param {string} project * @param {string} bucket * @returns {string} Resource name string. */ storageLayoutPath(project: string, bucket: string): string; /** * 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: string): string | number; /** * 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: string): string | number; /** * 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(): Promise; /** * Permanently deletes an empty bucket. * The request fails if there are any live or * noncurrent objects in the bucket, but the request succeeds if the * bucket only contains soft-deleted objects or incomplete uploads, such * as ongoing XML API multipart uploads. Does not permanently delete * soft-deleted objects. * * When this API is used to delete a bucket containing an object that has a * soft delete policy * enabled, the object becomes soft deleted, and the * `softDeleteTime` and `hardDeleteTime` properties are set on the * object. * * Objects and multipart uploads that were in the bucket at the time of * deletion are also retained for the specified retention duration. When * a soft-deleted bucket reaches the end of its retention duration, it * is permanently deleted. The `hardDeleteTime` of the bucket always * equals * or exceeds the expiration time of the last soft-deleted object in the * bucket. * * **IAM Permissions**: * * Requires `storage.buckets.delete` IAM permission on the bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of a bucket to delete. * @param {number} request.ifMetagenerationMatch * If set, only deletes the bucket if its metageneration matches this value. * @param {number} request.ifMetagenerationNotMatch * If set, only deletes the bucket if its metageneration does not match this * value. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.delete_bucket.js * region_tag:storage_v2_generated_Storage_DeleteBucket_async */ deleteBucket(request?: protos.google.storage.v2.IDeleteBucketRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.storage.v2.IDeleteBucketRequest | undefined, {} | undefined ]>; deleteBucket(request: protos.google.storage.v2.IDeleteBucketRequest, options: CallOptions, callback: Callback): void; deleteBucket(request: protos.google.storage.v2.IDeleteBucketRequest, callback: Callback): void; /** * Returns metadata for the specified bucket. * * **IAM Permissions**: * * Requires `storage.buckets.get` * IAM permission on * the bucket. Additionally, to return specific bucket metadata, the * authenticated user must have the following permissions: * * - To return the IAM policies: `storage.buckets.getIamPolicy` * - To return the bucket IP filtering rules: `storage.buckets.getIpFilter` * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Name of a bucket. * @param {number} request.ifMetagenerationMatch * If set, only gets the bucket metadata if its metageneration matches this * value. * @param {number} request.ifMetagenerationNotMatch * If set, and if the bucket's current metageneration matches the specified * value, the request returns an error. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read. * A `*` field might be used to indicate all fields. * If no mask is specified, it defaults to all fields. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.v2.Bucket|Bucket}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.get_bucket.js * region_tag:storage_v2_generated_Storage_GetBucket_async */ getBucket(request?: protos.google.storage.v2.IGetBucketRequest, options?: CallOptions): Promise<[ protos.google.storage.v2.IBucket, protos.google.storage.v2.IGetBucketRequest | undefined, {} | undefined ]>; getBucket(request: protos.google.storage.v2.IGetBucketRequest, options: CallOptions, callback: Callback): void; getBucket(request: protos.google.storage.v2.IGetBucketRequest, callback: Callback): void; /** * Creates a new bucket. * * **IAM Permissions**: * * Requires `storage.buckets.create` IAM permission on the bucket. * Additionally, to enable specific bucket features, the authenticated user * must have the following permissions: * * - To enable object retention using the `enableObjectRetention` query * parameter: `storage.buckets.enableObjectRetention` * - To set the bucket IP filtering rules: `storage.buckets.setIpFilter` * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project to which this bucket belongs. This field must either * be empty or `projects/_`. The project ID that owns this bucket should be * specified in the `bucket.project` field. * @param {google.storage.v2.Bucket} [request.bucket] * Optional. Properties of the new bucket being inserted. * The name of the bucket is specified in the `bucket_id` field. Populating * `bucket.name` field results in an error. * The project of the bucket must be specified in the `bucket.project` field. * This field must be in `projects/{projectIdentifier}` format, * {projectIdentifier} can be the project ID or project number. The `parent` * field must be either empty or `projects/_`. * @param {string} request.bucketId * Required. The ID to use for this bucket, which becomes the final component * of the bucket's resource name. For example, the value `foo` might result in * a bucket with the name `projects/123456/buckets/foo`. * @param {string} [request.predefinedAcl] * Optional. Apply a predefined set of access controls to this bucket. * Valid values are `authenticatedRead`, `private`, `projectPrivate`, * `publicRead`, or `publicReadWrite`. * @param {string} [request.predefinedDefaultObjectAcl] * Optional. Apply a predefined set of default object access controls to this * bucket. Valid values are `authenticatedRead`, `bucketOwnerFullControl`, * `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`. * @param {boolean} [request.enableObjectRetention] * Optional. If true, enable object retention on the bucket. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.v2.Bucket|Bucket}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.create_bucket.js * region_tag:storage_v2_generated_Storage_CreateBucket_async */ createBucket(request?: protos.google.storage.v2.ICreateBucketRequest, options?: CallOptions): Promise<[ protos.google.storage.v2.IBucket, protos.google.storage.v2.ICreateBucketRequest | undefined, {} | undefined ]>; createBucket(request: protos.google.storage.v2.ICreateBucketRequest, options: CallOptions, callback: Callback): void; createBucket(request: protos.google.storage.v2.ICreateBucketRequest, callback: Callback): void; /** * Permanently locks the retention * policy that is * currently applied to the specified bucket. * * Caution: Locking a bucket is an * irreversible action. Once you lock a bucket: * * - You cannot remove the retention policy from the bucket. * - You cannot decrease the retention period for the policy. * * Once locked, you must delete the entire bucket in order to remove the * bucket's retention policy. However, before you can delete the bucket, you * must delete all the objects in the bucket, which is only * possible if all the objects have reached the retention period set by the * retention policy. * * **IAM Permissions**: * * Requires `storage.buckets.update` IAM permission on the bucket. * * @param {Object} request * The request object that will be sent. * @param {string} request.bucket * Required. Name of a bucket. * @param {number} request.ifMetagenerationMatch * Required. Makes the operation conditional on whether bucket's current * metageneration matches the given value. Must be positive. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.v2.Bucket|Bucket}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.lock_bucket_retention_policy.js * region_tag:storage_v2_generated_Storage_LockBucketRetentionPolicy_async */ lockBucketRetentionPolicy(request?: protos.google.storage.v2.ILockBucketRetentionPolicyRequest, options?: CallOptions): Promise<[ protos.google.storage.v2.IBucket, protos.google.storage.v2.ILockBucketRetentionPolicyRequest | undefined, {} | undefined ]>; lockBucketRetentionPolicy(request: protos.google.storage.v2.ILockBucketRetentionPolicyRequest, options: CallOptions, callback: Callback): void; lockBucketRetentionPolicy(request: protos.google.storage.v2.ILockBucketRetentionPolicyRequest, callback: Callback): void; /** * Updates a bucket. Changes to the bucket are readable immediately after * writing, but configuration changes might take time to propagate. This * method supports `patch` semantics. * * **IAM Permissions**: * * Requires `storage.buckets.update` IAM permission on the bucket. * Additionally, to enable specific bucket features, the authenticated user * must have the following permissions: * * - To set bucket IP filtering rules: `storage.buckets.setIpFilter` * - To update public access prevention policies or access control lists * (ACLs): `storage.buckets.setIamPolicy` * * @param {Object} request * The request object that will be sent. * @param {google.storage.v2.Bucket} request.bucket * Required. The bucket to update. * The bucket's `name` field is used to identify the bucket. * @param {number} request.ifMetagenerationMatch * If set, the request modifies the bucket if its metageneration matches this * value. * @param {number} request.ifMetagenerationNotMatch * If set, the request modifies the bucket if its metageneration doesn't * match this value. * @param {string} [request.predefinedAcl] * Optional. Apply a predefined set of access controls to this bucket. * Valid values are `authenticatedRead`, `private`, `projectPrivate`, * `publicRead`, or `publicReadWrite`. * @param {string} [request.predefinedDefaultObjectAcl] * Optional. Apply a predefined set of default object access controls to this * bucket. Valid values are `authenticatedRead`, `bucketOwnerFullControl`, * `bucketOwnerRead`, `private`, `projectPrivate`, or `publicRead`. * @param {google.protobuf.FieldMask} request.updateMask * Required. List of fields to be updated. * * To specify ALL fields, equivalent to the JSON API's "update" function, * specify a single field with the value `*`. Note: not recommended. If a new * field is introduced at a later time, an older client updating with the `*` * might accidentally reset the new field's value. * * Not specifying any fields is an error. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.storage.v2.Bucket|Bucket}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.update_bucket.js * region_tag:storage_v2_generated_Storage_UpdateBucket_async */ updateBucket(request?: protos.google.storage.v2.IUpdateBucketRequest, options?: CallOptions): Promise<[ protos.google.storage.v2.IBucket, protos.google.storage.v2.IUpdateBucketRequest | undefined, {} | undefined ]>; updateBucket(request: protos.google.storage.v2.IUpdateBucketRequest, options: CallOptions, callback: Callback): void; updateBucket(request: protos.google.storage.v2.IUpdateBucketRequest, callback: Callback): void; /** * Retrieves a list of buckets for a given project, ordered * lexicographically by name. * * **IAM Permissions**: * * Requires `storage.buckets.list` IAM permission on the bucket. * Additionally, to enable specific bucket features, the authenticated * user must have the following permissions: * * - To list the IAM policies: `storage.buckets.getIamPolicy` * - To list the bucket IP filtering rules: `storage.buckets.getIpFilter` * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project whose buckets we are listing. * @param {number} [request.pageSize] * Optional. Maximum number of buckets to return in a single response. The * service uses this parameter or `1,000` items, whichever is smaller. If * `acl` is present in the `read_mask`, the service uses this parameter of * `200` items, whichever is smaller. * @param {string} [request.pageToken] * Optional. A previously-returned page token representing part of the larger * set of results to view. * @param {string} [request.prefix] * Optional. Filter results to buckets whose names begin with this prefix. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read from each result. * If no mask is specified, it defaults to all fields except `items. * owner`, `items.acl`, and `items.default_object_acl`. * `*` might be used to mean "all fields". * @param {boolean} [request.returnPartialSuccess] * Optional. Allows listing of buckets, even if there are buckets that are * unreachable. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.storage.v2.Bucket|Bucket}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listBucketsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBuckets(request?: protos.google.storage.v2.IListBucketsRequest, options?: CallOptions): Promise<[ protos.google.storage.v2.IBucket[], protos.google.storage.v2.IListBucketsRequest | null, protos.google.storage.v2.IListBucketsResponse ]>; listBuckets(request: protos.google.storage.v2.IListBucketsRequest, options: CallOptions, callback: PaginationCallback): void; listBuckets(request: protos.google.storage.v2.IListBucketsRequest, callback: PaginationCallback): void; /** * Equivalent to `listBuckets`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project whose buckets we are listing. * @param {number} [request.pageSize] * Optional. Maximum number of buckets to return in a single response. The * service uses this parameter or `1,000` items, whichever is smaller. If * `acl` is present in the `read_mask`, the service uses this parameter of * `200` items, whichever is smaller. * @param {string} [request.pageToken] * Optional. A previously-returned page token representing part of the larger * set of results to view. * @param {string} [request.prefix] * Optional. Filter results to buckets whose names begin with this prefix. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read from each result. * If no mask is specified, it defaults to all fields except `items. * owner`, `items.acl`, and `items.default_object_acl`. * `*` might be used to mean "all fields". * @param {boolean} [request.returnPartialSuccess] * Optional. Allows listing of buckets, even if there are buckets that are * unreachable. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.storage.v2.Bucket|Bucket} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listBucketsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listBucketsStream(request?: protos.google.storage.v2.IListBucketsRequest, options?: CallOptions): Transform; /** * Equivalent to `listBuckets`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The project whose buckets we are listing. * @param {number} [request.pageSize] * Optional. Maximum number of buckets to return in a single response. The * service uses this parameter or `1,000` items, whichever is smaller. If * `acl` is present in the `read_mask`, the service uses this parameter of * `200` items, whichever is smaller. * @param {string} [request.pageToken] * Optional. A previously-returned page token representing part of the larger * set of results to view. * @param {string} [request.prefix] * Optional. Filter results to buckets whose names begin with this prefix. * @param {google.protobuf.FieldMask} request.readMask * Mask specifying which fields to read from each result. * If no mask is specified, it defaults to all fields except `items. * owner`, `items.acl`, and `items.default_object_acl`. * `*` might be used to mean "all fields". * @param {boolean} [request.returnPartialSuccess] * Optional. Allows listing of buckets, even if there are buckets that are * unreachable. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.storage.v2.Bucket|Bucket}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/storage.list_buckets.js * region_tag:storage_v2_generated_Storage_ListBuckets_async */ listBucketsAsync(request?: protos.google.storage.v2.IListBucketsRequest, options?: CallOptions): AsyncIterable; /** * Return a fully-qualified cryptoKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @returns {string} Resource name string. */ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string; /** * Parse the project from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the location from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the key_ring from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the crypto_key from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number; }