@google-cloud/storage-control 0.1.0 → 0.2.0

package/build/src/v2/storage_control_client.d.ts

@@ -117,26 +117,32 @@ export declare class StorageControlClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Creates a new folder.
+     * Creates a new folder. This operation is only applicable to a hierarchical
+     * namespace enabled bucket.
+     * Hierarchical namespace buckets are in allowlist preview.
      *
      * @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.
+     *   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 absolute path of the folder, using a single `/` as delimiter.
+     *   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. This request is only
-     *   idempotent if a `request_id` is provided.
+     *   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.
@@ -154,7 +160,9 @@ export declare class StorageControlClient {
     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.
+     * Permanently deletes an empty folder. This operation is only applicable to a
+     * hierarchical namespace enabled bucket.
+     * Hierarchical namespace buckets are in allowlist preview.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -169,8 +177,7 @@ export declare class StorageControlClient {
      *   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.
+     *   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.
@@ -188,7 +195,9 @@ export declare class StorageControlClient {
     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.
+     * Returns metadata for the specified folder. This operation is only
+     * applicable to a hierarchical namespace enabled bucket.
+     * Hierarchical namespace buckets are in allowlist preview.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -251,9 +260,118 @@ export declare class StorageControlClient {
     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;
     /**
-     * Renames a source folder to a destination folder. During a rename, the
+     * 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.
+     * Hierarchical namespace buckets are in allowlist preview.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -303,12 +421,15 @@ export declare class StorageControlClient {
      */
     checkRenameFolderProgress(name: string): Promise<LROperation<protos.google.storage.control.v2.Folder, protos.google.storage.control.v2.RenameFolderMetadata>>;
     /**
-     * Retrieves a list of folders for a given bucket.
+     * Retrieves a list of folders. This operation is only applicable to a
+     * hierarchical namespace enabled bucket.
+     * Hierarchical namespace buckets are in allowlist preview.
      *
      * @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.
+     *   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.
@@ -359,7 +480,8 @@ export declare class StorageControlClient {
      * @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.
+     *   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.
@@ -405,7 +527,8 @@ export declare class StorageControlClient {
      * @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.
+     *   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.
@@ -445,6 +568,107 @@ export declare class StorageControlClient {
      * 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 `method.name.toCamelCase()`, 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
@@ -622,6 +846,39 @@ export declare class StorageControlClient {
      * @returns {string} A string representing the folder.
      */
     matchFolderFromFolderName(folderName: string): string | number;
+    /**
+     * Return a fully-qualified managedFolder resource name string.
+     *
+     * @param {string} project
+     * @param {string} bucket
+     * @param {string} managed_folder
+     * @returns {string} Resource name string.
+     */
+    managedFolderPath(project: string, bucket: string, managedFolder: string): string;
+    /**
+     * Parse the project from ManagedFolder resource.
+     *
+     * @param {string} managedFolderName
+     *   A fully-qualified path representing ManagedFolder resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromManagedFolderName(managedFolderName: string): string | number;
+    /**
+     * Parse the bucket from ManagedFolder resource.
+     *
+     * @param {string} managedFolderName
+     *   A fully-qualified path representing ManagedFolder resource.
+     * @returns {string} A string representing the bucket.
+     */
+    matchBucketFromManagedFolderName(managedFolderName: string): string | number;
+    /**
+     * Parse the managed_folder from ManagedFolder resource.
+     *
+     * @param {string} managedFolderName
+     *   A fully-qualified path representing ManagedFolder resource.
+     * @returns {string} A string representing the managed_folder.
+     */
+    matchManagedFolderFromManagedFolderName(managedFolderName: string): string | number;
     /**
      * Return a fully-qualified project resource name string.
      *