UNPKG

@google-cloud/storage-control

Version:
705 lines 135 kB
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<string, undefined, undefined>): Promise<string> | 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 <caption>include:samples/generated/v2/storage_control.create_folder.js</caption> * 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<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.ICreateFolderRequest | null | undefined, {} | null | undefined>): void; createFolder(request: protos.google.storage.control.v2.ICreateFolderRequest, callback: Callback<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.ICreateFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.delete_folder.js</caption> * 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<protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteFolderRequest | null | undefined, {} | null | undefined>): void; deleteFolder(request: protos.google.storage.control.v2.IDeleteFolderRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_folder.js</caption> * 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<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IGetFolderRequest | null | undefined, {} | null | undefined>): void; getFolder(request: protos.google.storage.control.v2.IGetFolderRequest, callback: Callback<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IGetFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_storage_layout.js</caption> * 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<protos.google.storage.control.v2.IStorageLayout, protos.google.storage.control.v2.IGetStorageLayoutRequest | null | undefined, {} | null | undefined>): void; getStorageLayout(request: protos.google.storage.control.v2.IGetStorageLayoutRequest, callback: Callback<protos.google.storage.control.v2.IStorageLayout, protos.google.storage.control.v2.IGetStorageLayoutRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.create_managed_folder.js</caption> * 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<protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.ICreateManagedFolderRequest | null | undefined, {} | null | undefined>): void; createManagedFolder(request: protos.google.storage.control.v2.ICreateManagedFolderRequest, callback: Callback<protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.ICreateManagedFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.delete_managed_folder.js</caption> * 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<protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteManagedFolderRequest | null | undefined, {} | null | undefined>): void; deleteManagedFolder(request: protos.google.storage.control.v2.IDeleteManagedFolderRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.storage.control.v2.IDeleteManagedFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_managed_folder.js</caption> * 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<protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.IGetManagedFolderRequest | null | undefined, {} | null | undefined>): void; getManagedFolder(request: protos.google.storage.control.v2.IGetManagedFolderRequest, callback: Callback<protos.google.storage.control.v2.IManagedFolder, protos.google.storage.control.v2.IGetManagedFolderRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.disable_anywhere_cache.js</caption> * 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<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IDisableAnywhereCacheRequest | null | undefined, {} | null | undefined>): void; disableAnywhereCache(request: protos.google.storage.control.v2.IDisableAnywhereCacheRequest, callback: Callback<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IDisableAnywhereCacheRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.pause_anywhere_cache.js</caption> * 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<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IPauseAnywhereCacheRequest | null | undefined, {} | null | undefined>): void; pauseAnywhereCache(request: protos.google.storage.control.v2.IPauseAnywhereCacheRequest, callback: Callback<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IPauseAnywhereCacheRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.resume_anywhere_cache.js</caption> * 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<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IResumeAnywhereCacheRequest | null | undefined, {} | null | undefined>): void; resumeAnywhereCache(request: protos.google.storage.control.v2.IResumeAnywhereCacheRequest, callback: Callback<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IResumeAnywhereCacheRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_anywhere_cache.js</caption> * 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<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IGetAnywhereCacheRequest | null | undefined, {} | null | undefined>): void; getAnywhereCache(request: protos.google.storage.control.v2.IGetAnywhereCacheRequest, callback: Callback<protos.google.storage.control.v2.IAnywhereCache, protos.google.storage.control.v2.IGetAnywhereCacheRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_project_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; getProjectIntelligenceConfig(request: protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetProjectIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.update_project_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; updateProjectIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateProjectIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_folder_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; getFolderIntelligenceConfig(request: protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetFolderIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.update_folder_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; updateFolderIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateFolderIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_organization_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; getOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IGetOrganizationIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.update_organization_intelligence_config.js</caption> * 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<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest | null | undefined, {} | null | undefined>): void; updateOrganizationIntelligenceConfig(request: protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest, callback: Callback<protos.google.storage.control.v2.IIntelligenceConfig, protos.google.storage.control.v2.IUpdateOrganizationIntelligenceConfigRequest | null | undefined, {} | null | undefined>): 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 <caption>include:samples/generated/v2/storage_control.get_iam_policy.js</caption> * 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<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): 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 det