@google-cloud/storage-control 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.2.0](https://github.com/googleapis/google-cloud-node/compare/storage-control-v0.1.1...storage-control-v0.2.0) (2024-05-21)
+
+
+### Features
+
+* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5351](https://github.com/googleapis/google-cloud-node/issues/5351)) ([01f48fc](https://github.com/googleapis/google-cloud-node/commit/01f48fce63ec4ddf801d59ee2b8c0db9f6fb8372))
+* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5354](https://github.com/googleapis/google-cloud-node/issues/5354)) ([a9784ed](https://github.com/googleapis/google-cloud-node/commit/a9784ed3db6ee96d171762308bbbcd57390b6866))
+
+## [0.1.1](https://github.com/googleapis/google-cloud-node/compare/storage-control-v0.1.0...storage-control-v0.1.1) (2024-05-08)
+
+
+### Bug Fixes
+
+* [storage] An existing resource pattern value `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder=**}` to resource definition `storage.googleapis.com/ManagedFolder` is removed ([#5311](https://github.com/googleapis/google-cloud-node/issues/5311)) ([e8dd1b7](https://github.com/googleapis/google-cloud-node/commit/e8dd1b7aa0e455acf2179787b498e6b6a934672b))
+
 ## 0.1.0 (2024-04-16)
 
 

package/README.md

@@ -102,10 +102,14 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
 | Sample                      | Source Code                       | Try it |
 | --------------------------- | --------------------------------- | ------ |
 | Storage_control.create_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.create_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.create_folder.js,packages/google-storage-control/samples/README.md) |
+| Storage_control.create_managed_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.create_managed_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.create_managed_folder.js,packages/google-storage-control/samples/README.md) |
 | Storage_control.delete_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.delete_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.delete_folder.js,packages/google-storage-control/samples/README.md) |
+| Storage_control.delete_managed_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.delete_managed_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.delete_managed_folder.js,packages/google-storage-control/samples/README.md) |
 | Storage_control.get_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.get_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.get_folder.js,packages/google-storage-control/samples/README.md) |
+| Storage_control.get_managed_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.get_managed_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.get_managed_folder.js,packages/google-storage-control/samples/README.md) |
 | Storage_control.get_storage_layout | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.get_storage_layout.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.get_storage_layout.js,packages/google-storage-control/samples/README.md) |
 | Storage_control.list_folders | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.list_folders.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.list_folders.js,packages/google-storage-control/samples/README.md) |
+| Storage_control.list_managed_folders | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.list_managed_folders.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.list_managed_folders.js,packages/google-storage-control/samples/README.md) |
 | Storage_control.rename_folder | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/generated/v2/storage_control.rename_folder.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/generated/v2/storage_control.rename_folder.js,packages/google-storage-control/samples/README.md) |
 | Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-storage-control/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-storage-control/samples/quickstart.js,packages/google-storage-control/samples/README.md) |
 

package/build/protos/google/storage/control/v2/storage_control.proto

@@ -1,4 +1,4 @@
-// Copyright 2023 Google LLC
+// Copyright 2024 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -47,7 +47,9 @@ service StorageControl {
       "https://www.googleapis.com/auth/devstorage.read_only,"
       "https://www.googleapis.com/auth/devstorage.read_write";
 
-  // 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.
   rpc CreateFolder(CreateFolderRequest) returns (Folder) {
     option (google.api.routing) = {
       routing_parameters { field: "parent" path_template: "{bucket=**}" }
@@ -55,7 +57,9 @@ service StorageControl {
     option (google.api.method_signature) = "parent,folder,folder_id";
   }
 
-  // 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.
   rpc DeleteFolder(DeleteFolderRequest) returns (google.protobuf.Empty) {
     option (google.api.routing) = {
       routing_parameters {
@@ -66,7 +70,9 @@ service StorageControl {
     option (google.api.method_signature) = "name";
   }
 
-  // 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.
   rpc GetFolder(GetFolderRequest) returns (Folder) {
     option (google.api.routing) = {
       routing_parameters {
@@ -77,7 +83,9 @@ service StorageControl {
     option (google.api.method_signature) = "name";
   }
 
-  // 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.
   rpc ListFolders(ListFoldersRequest) returns (ListFoldersResponse) {
     option (google.api.routing) = {
       routing_parameters { field: "parent" path_template: "{bucket=**}" }
@@ -85,9 +93,11 @@ service StorageControl {
     option (google.api.method_signature) = "parent";
   }
 
-  // Renames a source folder to a destination folder. During a rename, the
+  // 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.
   rpc RenameFolder(RenameFolderRequest) returns (google.longrunning.Operation) {
     option (google.api.routing) = {
       routing_parameters {
@@ -112,6 +122,47 @@ service StorageControl {
     };
     option (google.api.method_signature) = "name";
   }
+
+  // Creates a new managed folder.
+  rpc CreateManagedFolder(CreateManagedFolderRequest) returns (ManagedFolder) {
+    option (google.api.routing) = {
+      routing_parameters { field: "parent" path_template: "{bucket=**}" }
+    };
+    option (google.api.method_signature) =
+        "parent,managed_folder,managed_folder_id";
+  }
+
+  // Permanently deletes an empty managed folder.
+  rpc DeleteManagedFolder(DeleteManagedFolderRequest)
+      returns (google.protobuf.Empty) {
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{bucket=projects/*/buckets/*}/**"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Returns metadata for the specified managed folder.
+  rpc GetManagedFolder(GetManagedFolderRequest) returns (ManagedFolder) {
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{bucket=projects/*/buckets/*}/**"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Retrieves a list of managed folders for a given bucket.
+  rpc ListManagedFolders(ListManagedFoldersRequest)
+      returns (ListManagedFoldersResponse) {
+    option (google.api.routing) = {
+      routing_parameters { field: "parent" path_template: "{bucket=**}" }
+    };
+    option (google.api.method_signature) = "parent";
+  }
 }
 
 // Contains information about a pending rename operation.
@@ -120,7 +171,9 @@ message PendingRenameInfo {
   string operation = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// A folder.
+// A folder resource. This resource can only exist in a hierarchical namespace
+// enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message Folder {
   option (google.api.resource) = {
     type: "storage.googleapis.com/Folder"
@@ -154,7 +207,9 @@ message Folder {
       [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
-// Request message for GetFolder.
+// Request message for GetFolder. This operation is only applicable to a
+// hierarchical namespace enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message GetFolderRequest {
   // Required. Name of the folder.
   // Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
@@ -179,9 +234,12 @@ message GetFolderRequest {
   ];
 }
 
-// Request message for CreateFolder.
+// Request message for CreateFolder. This operation is only applicable to a
+// hierarchical namespace enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message CreateFolderRequest {
-  // 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.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -195,7 +253,11 @@ message CreateFolderRequest {
   // error.
   Folder folder = 2 [(google.api.field_behavior) = REQUIRED];
 
-  // 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.
   string folder_id = 3 [(google.api.field_behavior) = REQUIRED];
 
   // Optional. If true, parent folder doesn't have to be present and all missing
@@ -203,15 +265,16 @@ message CreateFolderRequest {
   bool recursive = 4 [(google.api.field_behavior) = OPTIONAL];
 
   // 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.
   string request_id = 5 [
     (google.api.field_info).format = UUID4,
     (google.api.field_behavior) = OPTIONAL
   ];
 }
 
-// Request message for DeleteFolder.
+// Request message for DeleteFolder. This operation is only applicable to a
+// hierarchical namespace enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message DeleteFolderRequest {
   // Required. Name of the folder.
   // Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
@@ -229,17 +292,19 @@ message DeleteFolderRequest {
   optional int64 if_metageneration_not_match = 4;
 
   // 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.
   string request_id = 5 [
     (google.api.field_info).format = UUID4,
     (google.api.field_behavior) = OPTIONAL
   ];
 }
 
-// Request message for ListFolders.
+// Request message for ListFolders. This operation is only applicable to a
+// hierarchical namespace enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message ListFoldersRequest {
-  // 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.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -294,7 +359,9 @@ message ListFoldersResponse {
   string next_page_token = 2;
 }
 
-// Request message for RenameFolder.
+// Request message for RenameFolder. This operation is only applicable to a
+// hierarchical namespace enabled bucket.
+// Hierarchical namespace buckets are in allowlist preview.
 message RenameFolderRequest {
   // Required. Name of the source folder being renamed.
   // Format: `projects/{project}/buckets/{bucket}/folders/{folder}`
@@ -428,3 +495,161 @@ message GetStorageLayoutRequest {
     (google.api.field_behavior) = OPTIONAL
   ];
 }
+
+// A managed folder.
+message ManagedFolder {
+  option (google.api.resource) = {
+    type: "storage.googleapis.com/ManagedFolder"
+    pattern: "projects/{project}/buckets/{bucket}/managedFolders/{managed_folder=**}"
+    plural: "managedFolders"
+    singular: "managedFolder"
+  };
+
+  // Identifier. The name of this managed folder.
+  // Format:
+  // `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
+  string name = 1 [(google.api.field_behavior) = IDENTIFIER];
+
+  // Output only. The metadata version of this managed folder. It increases
+  // whenever the metadata is updated. Used for preconditions and for detecting
+  // changes in metadata. Managed folders don't have a generation number.
+  int64 metageneration = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The creation time of the managed folder.
+  google.protobuf.Timestamp create_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The modification time of the managed folder.
+  google.protobuf.Timestamp update_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Request message for GetManagedFolder.
+message GetManagedFolderRequest {
+  // Required. Name of the managed folder.
+  // Format:
+  // `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
+  string name = 6 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "storage.googleapis.com/ManagedFolder"
+    }
+  ];
+
+  // The operation succeeds conditional on the managed folder's current
+  // metageneration matching the value here specified.
+  optional int64 if_metageneration_match = 3;
+
+  // The operation succeeds conditional on the managed folder's current
+  // metageneration NOT matching the value here specified.
+  optional int64 if_metageneration_not_match = 4;
+
+  // Optional. A unique identifier for this request. UUID is the recommended
+  // format, but other formats are still accepted.
+  string request_id = 5 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// Request message for CreateManagedFolder.
+message CreateManagedFolderRequest {
+  // Required. Name of the bucket this managed folder belongs to.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "storage.googleapis.com/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.
+  ManagedFolder managed_folder = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The name of the managed folder. It uses a single `/` as delimiter
+  // and leading and trailing `/` are allowed.
+  string managed_folder_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // Optional. A unique identifier for this request. UUID is the recommended
+  // format, but other formats are still accepted.
+  string request_id = 4 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// DeleteManagedFolder RPC request message.
+message DeleteManagedFolderRequest {
+  // Required. Name of the managed folder.
+  // Format:
+  // `projects/{project}/buckets/{bucket}/managedFolders/{managedFolder}`
+  string name = 7 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "storage.googleapis.com/ManagedFolder"
+    }
+  ];
+
+  // The operation succeeds conditional on the managed folder's current
+  // metageneration matching the value here specified.
+  optional int64 if_metageneration_match = 3;
+
+  // The operation succeeds conditional on the managed folder's current
+  // metageneration NOT matching the value here specified.
+  optional int64 if_metageneration_not_match = 4;
+
+  // 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.
+  bool allow_non_empty = 5;
+
+  // Optional. A unique identifier for this request. UUID is the recommended
+  // format, but other formats are still accepted.
+  string request_id = 6 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// Request message for ListManagedFolders.
+message ListManagedFoldersRequest {
+  // Required. Name of the bucket this managed folder belongs to.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      child_type: "storage.googleapis.com/ManagedFolder"
+    }
+  ];
+
+  // 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.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A previously-returned page token representing part of the larger
+  // set of results to view.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Filter results to match managed folders with name starting with
+  // this prefix.
+  string prefix = 4 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. A unique identifier for this request. UUID is the recommended
+  // format, but other formats are still accepted.
+  string request_id = 5 [
+    (google.api.field_info).format = UUID4,
+    (google.api.field_behavior) = OPTIONAL
+  ];
+}
+
+// Response message for ListManagedFolders.
+message ListManagedFoldersResponse {
+  // The list of matching managed folders
+  repeated ManagedFolder managed_folders = 1;
+
+  // The continuation token, used to page through large result sets. Provide
+  // this value in a subsequent request to return the next page of results.
+  string next_page_token = 2;
+}