@google-cloud/storage-control/build/src/v2/storage_control_client.d.ts

Cloud Storage API client for Node.js

import * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
 *  StorageControl service includes selected control plane operations.
 * @class
 * @memberof v2
 */
export declare class StorageControlClient {
    private _terminated;
    private _opts;
    private _providedCustomServicePath;
    private _gaxModule;
    private _gaxGrpc;
    private _protos;
    private _defaults;
    private _universeDomain;
    private _servicePath;
    private _log;
    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;
    }>;
    /**
     * Construct an instance of StorageControlClient.
     *
     * @param {object} [options] - The configuration object.
     * The options accepted by the constructor are described in detail
     * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
     * The common options are:
     * @param {object} [options.credentials] - Credentials object.
     * @param {string} [options.credentials.client_email]
     * @param {string} [options.credentials.private_key]
     * @param {string} [options.email] - Account email address. Required when
     *     using a .pem or .p12 keyFilename.
     * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
     *     .p12 key downloaded from the Google Developers Console. If you provide
     *     a path to a JSON file, the projectId option below is not necessary.
     *     NOTE: .pem and .p12 require you to specify options.email as well.
     * @param {number} [options.port] - The port on which to connect to
     *     the remote host.
     * @param {string} [options.projectId] - The project ID from the Google
     *     Developer's Console, e.g. 'grape-spaceship-123'. We will also check
     *     the environment variable GCLOUD_PROJECT for your project ID. If your
     *     app is running in an environment which supports
     *     {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
     *     your project ID will be detected automatically.
     * @param {string} [options.apiEndpoint] - The domain name of the
     *     API remote host.
     * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
     *     Follows the structure of {@link gapicConfig}.
     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
     *     For more information, please check the
     *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
     * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
     *     need to avoid loading the default gRPC version and want to use the fallback
     *     HTTP implementation. Load only fallback version and pass it to the constructor:
     *     ```
     *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
     *     const client = new StorageControlClient({fallback: true}, gax);
     *     ```
     */
    constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
    /**
     * 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.
     * @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(): Promise<string>;
    getProjectId(callback: Callback<string, undefined, undefined>): 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;
    /**
     * 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 <caption>include:samples/generated/v2/storage_control.rename_folder.js</caption>
     * region_tag:storage_v2_generated_StorageControl_RenameFolder_async
     */
    renameFolder(request?: protos.google.storage.control.v2.IRenameFolderRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IRenameFolderMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;
    renameFolder(request: protos.google.storage.control.v2.IRenameFolderRequest, options: CallOptions, callback: Callback<LROperation<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IRenameFolderMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
    renameFolder(request: protos.google.storage.control.v2.IRenameFolderRequest, callback: Callback<LROperation<protos.google.storage.control.v2.IFolder, protos.google.storage.control.v2.IRenameFolderMetadata>, 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 <caption>include:samples/generated/v2/storage_control.rename_folder.js</caption>
     * region_tag:storage_v2_generated_StorageControl_RenameFolder_async
     */
    checkRenameFolderProgress(name: string): Promise<LROperation<protos.google.storage.control.v2.Folder, protos.google.storage.control.v2.RenameFolderMetadata>>;
    /**
     * 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<protos.google.storage.control.v2.IListFoldersRequest, protos.google.storage.control.v2.IListFoldersResponse | null | undefined, protos.google.storage.control.v2.IFolder>): void;
    listFolders(request: protos.google.storage.control.v2.IListFoldersRequest, callback: PaginationCallback<protos.google.storage.control.v2.IListFoldersRequest, protos.google.storage.control.v2.IListFoldersResponse | null | undefined, protos.google.storage.control.v2.IFolder>): 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 <caption>include:samples/generated/v2/storage_control.list_folders.js</caption>
     * region_tag:storage_v2_generated_StorageControl_ListFolders_async
     */
    listFoldersAsync(request?: protos.google.storage.control.v2.IListFoldersRequest, options?: CallOptions): AsyncIterable<protos.google.storage.control.v2.IFolder>;
    /**
     * 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<protos.google.storage.control.v2.IListManagedFoldersRequest, protos.google.storage.control.v2.IListManagedFoldersResponse | null | undefined, protos.google.storage.control.v2.IManagedFolder>): void;
    listManagedFolders(request: protos.google.storage.control.v2.IListManagedFoldersRequest, callback: PaginationCallback<protos.google.storage.control.v2.IListManagedFoldersRequest, protos.google.storage.control.v2.IListManagedFoldersResponse | null | undefined, protos.google.storage.control.v2.IManagedFolder>): 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 <caption>include:samples/generated/v2/storage_control.list_managed_folders.js</caption>
     * region_tag:storage_v2_generated_StorageControl_ListManagedFolders_async
     */
    listManagedFoldersAsync(request?: protos.google.storage.control.v2.IListManagedFoldersRequest, options?: CallOptions): AsyncIterable<protos.google.storage.control.v2.IManagedFolder>;
    /**
     * 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, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
    /**
     * 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<protos.google.longrunning.IOperation>;
    /**
     * 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, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
    /**
     * 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.UNIMPLE