Skip to content

Commit b593dd7

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [google-cloud-storage-control] update storage control documentation (#12594)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 626165497 Source-Link: googleapis/googleapis@1125069 Source-Link: googleapis/googleapis-gen@a09be5f Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXN0b3JhZ2UtY29udHJvbC8uT3dsQm90LnlhbWwiLCJoIjoiYTA5YmU1Zjc3YjBkOGMyOGRhMjkyMWZjZTcyZjBlMWMwNmU3MjViNCJ9 --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 5c3f95c commit b593dd7

8 files changed

Lines changed: 194 additions & 65 deletions

File tree

‎packages/google-cloud-storage-control/google/cloud/storage_control/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.2" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-storage-control/google/cloud/storage_control_v2/gapic_version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
# See the License for the specific language governing permissions and
1414
# limitations under the License.
1515
#
16-
__version__ = "0.1.2" # {x-release-please-version}
16+
__version__ = "0.0.0" # {x-release-please-version}

‎packages/google-cloud-storage-control/google/cloud/storage_control_v2/services/storage_control/async_client.py‎

Lines changed: 60 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,9 @@ async def create_folder(
279279
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
280280
metadata: Sequence[Tuple[str, str]] = (),
281281
) -> storage_control.Folder:
282-
r"""Creates a new folder.
282+
r"""Creates a new folder. This operation is only
283+
applicable to a hierarchical namespace enabled bucket.
284+
Hierarchical namespace buckets are in allowlist preview.
283285
284286
.. code-block:: python
285287
@@ -311,9 +313,15 @@ async def sample_create_folder():
311313
Args:
312314
request (Optional[Union[google.cloud.storage_control_v2.types.CreateFolderRequest, dict]]):
313315
The request object. Request message for CreateFolder.
316+
This operation is only applicable to a
317+
hierarchical namespace enabled bucket.
318+
Hierarchical namespace buckets are in
319+
allowlist preview.
314320
parent (:class:`str`):
315321
Required. Name of the bucket in which
316-
the folder will reside.
322+
the folder will reside. The bucket must
323+
be a hierarchical namespace enabled
324+
bucket.
317325
318326
This corresponds to the ``parent`` field
319327
on the ``request`` instance; if ``request`` is provided, this
@@ -346,7 +354,11 @@ async def sample_create_folder():
346354
347355
Returns:
348356
google.cloud.storage_control_v2.types.Folder:
349-
A folder.
357+
A folder resource. This resource can
358+
only exist in a hierarchical namespace
359+
enabled bucket. Hierarchical namespace
360+
buckets are in allowlist preview.
361+
350362
"""
351363
# Create or coerce a protobuf request object.
352364
# Quick check: If we got a request object, we should *not* have
@@ -403,7 +415,10 @@ async def delete_folder(
403415
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
404416
metadata: Sequence[Tuple[str, str]] = (),
405417
) -> None:
406-
r"""Permanently deletes an empty folder.
418+
r"""Permanently deletes an empty folder. This operation
419+
is only applicable to a hierarchical namespace enabled
420+
bucket. Hierarchical namespace buckets are in allowlist
421+
preview.
407422
408423
.. code-block:: python
409424
@@ -431,6 +446,10 @@ async def sample_delete_folder():
431446
Args:
432447
request (Optional[Union[google.cloud.storage_control_v2.types.DeleteFolderRequest, dict]]):
433448
The request object. Request message for DeleteFolder.
449+
This operation is only applicable to a
450+
hierarchical namespace enabled bucket.
451+
Hierarchical namespace buckets are in
452+
allowlist preview.
434453
name (:class:`str`):
435454
Required. Name of the folder. Format:
436455
``projects/{project}/buckets/{bucket}/folders/{folder}``
@@ -492,7 +511,10 @@ async def get_folder(
492511
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
493512
metadata: Sequence[Tuple[str, str]] = (),
494513
) -> storage_control.Folder:
495-
r"""Returns metadata for the specified folder.
514+
r"""Returns metadata for the specified folder. This
515+
operation is only applicable to a hierarchical namespace
516+
enabled bucket. Hierarchical namespace buckets are in
517+
allowlist preview.
496518
497519
.. code-block:: python
498520
@@ -522,7 +544,11 @@ async def sample_get_folder():
522544
523545
Args:
524546
request (Optional[Union[google.cloud.storage_control_v2.types.GetFolderRequest, dict]]):
525-
The request object. Request message for GetFolder.
547+
The request object. Request message for GetFolder. This
548+
operation is only applicable to a
549+
hierarchical namespace enabled bucket.
550+
Hierarchical namespace buckets are in
551+
allowlist preview.
526552
name (:class:`str`):
527553
Required. Name of the folder. Format:
528554
``projects/{project}/buckets/{bucket}/folders/{folder}``
@@ -538,7 +564,11 @@ async def sample_get_folder():
538564
539565
Returns:
540566
google.cloud.storage_control_v2.types.Folder:
541-
A folder.
567+
A folder resource. This resource can
568+
only exist in a hierarchical namespace
569+
enabled bucket. Hierarchical namespace
570+
buckets are in allowlist preview.
571+
542572
"""
543573
# Create or coerce a protobuf request object.
544574
# Quick check: If we got a request object, we should *not* have
@@ -604,7 +634,9 @@ async def list_folders(
604634
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
605635
metadata: Sequence[Tuple[str, str]] = (),
606636
) -> pagers.ListFoldersAsyncPager:
607-
r"""Retrieves a list of folders for a given bucket.
637+
r"""Retrieves a list of folders. This operation is only
638+
applicable to a hierarchical namespace enabled bucket.
639+
Hierarchical namespace buckets are in allowlist preview.
608640
609641
.. code-block:: python
610642
@@ -635,10 +667,15 @@ async def sample_list_folders():
635667
636668
Args:
637669
request (Optional[Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]]):
638-
The request object. Request message for ListFolders.
670+
The request object. Request message for ListFolders. This
671+
operation is only applicable to a
672+
hierarchical namespace enabled bucket.
673+
Hierarchical namespace buckets are in
674+
allowlist preview.
639675
parent (:class:`str`):
640676
Required. Name of the bucket in which
641-
to look for folders.
677+
to look for folders. The bucket must be
678+
a hierarchical namespace enabled bucket.
642679
643680
This corresponds to the ``parent`` field
644681
on the ``request`` instance; if ``request`` is provided, this
@@ -729,9 +766,12 @@ async def rename_folder(
729766
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
730767
metadata: Sequence[Tuple[str, str]] = (),
731768
) -> operation_async.AsyncOperation:
732-
r"""Renames a source folder to a destination folder.
733-
During a rename, the source and destination folders are
734-
locked until the long running operation completes.
769+
r"""Renames a source folder to a destination folder. This
770+
operation is only applicable to a hierarchical namespace
771+
enabled bucket. During a rename, the source and
772+
destination folders are locked until the long running
773+
operation completes.
774+
Hierarchical namespace buckets are in allowlist preview.
735775
736776
.. code-block:: python
737777
@@ -767,6 +807,10 @@ async def sample_rename_folder():
767807
Args:
768808
request (Optional[Union[google.cloud.storage_control_v2.types.RenameFolderRequest, dict]]):
769809
The request object. Request message for RenameFolder.
810+
This operation is only applicable to a
811+
hierarchical namespace enabled bucket.
812+
Hierarchical namespace buckets are in
813+
allowlist preview.
770814
name (:class:`str`):
771815
Required. Name of the source folder being renamed.
772816
Format:
@@ -790,9 +834,9 @@ async def sample_rename_folder():
790834
google.api_core.operation_async.AsyncOperation:
791835
An object representing a long-running operation.
792836
793-
The result type for the operation will be
794-
:class:`google.cloud.storage_control_v2.types.Folder` A
795-
folder.
837+
The result type for the operation will be :class:`google.cloud.storage_control_v2.types.Folder` A folder resource. This resource can only exist in a hierarchical namespace
838+
enabled bucket. Hierarchical namespace buckets are in
839+
allowlist preview.
796840
797841
"""
798842
# Create or coerce a protobuf request object.

‎packages/google-cloud-storage-control/google/cloud/storage_control_v2/services/storage_control/client.py‎

Lines changed: 60 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,9 @@ def create_folder(
725725
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
726726
metadata: Sequence[Tuple[str, str]] = (),
727727
) -> storage_control.Folder:
728-
r"""Creates a new folder.
728+
r"""Creates a new folder. This operation is only
729+
applicable to a hierarchical namespace enabled bucket.
730+
Hierarchical namespace buckets are in allowlist preview.
729731
730732
.. code-block:: python
731733
@@ -757,9 +759,15 @@ def sample_create_folder():
757759
Args:
758760
request (Union[google.cloud.storage_control_v2.types.CreateFolderRequest, dict]):
759761
The request object. Request message for CreateFolder.
762+
This operation is only applicable to a
763+
hierarchical namespace enabled bucket.
764+
Hierarchical namespace buckets are in
765+
allowlist preview.
760766
parent (str):
761767
Required. Name of the bucket in which
762-
the folder will reside.
768+
the folder will reside. The bucket must
769+
be a hierarchical namespace enabled
770+
bucket.
763771
764772
This corresponds to the ``parent`` field
765773
on the ``request`` instance; if ``request`` is provided, this
@@ -792,7 +800,11 @@ def sample_create_folder():
792800
793801
Returns:
794802
google.cloud.storage_control_v2.types.Folder:
795-
A folder.
803+
A folder resource. This resource can
804+
only exist in a hierarchical namespace
805+
enabled bucket. Hierarchical namespace
806+
buckets are in allowlist preview.
807+
796808
"""
797809
# Create or coerce a protobuf request object.
798810
# Quick check: If we got a request object, we should *not* have
@@ -861,7 +873,10 @@ def delete_folder(
861873
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
862874
metadata: Sequence[Tuple[str, str]] = (),
863875
) -> None:
864-
r"""Permanently deletes an empty folder.
876+
r"""Permanently deletes an empty folder. This operation
877+
is only applicable to a hierarchical namespace enabled
878+
bucket. Hierarchical namespace buckets are in allowlist
879+
preview.
865880
866881
.. code-block:: python
867882
@@ -889,6 +904,10 @@ def sample_delete_folder():
889904
Args:
890905
request (Union[google.cloud.storage_control_v2.types.DeleteFolderRequest, dict]):
891906
The request object. Request message for DeleteFolder.
907+
This operation is only applicable to a
908+
hierarchical namespace enabled bucket.
909+
Hierarchical namespace buckets are in
910+
allowlist preview.
892911
name (str):
893912
Required. Name of the folder. Format:
894913
``projects/{project}/buckets/{bucket}/folders/{folder}``
@@ -964,7 +983,10 @@ def get_folder(
964983
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
965984
metadata: Sequence[Tuple[str, str]] = (),
966985
) -> storage_control.Folder:
967-
r"""Returns metadata for the specified folder.
986+
r"""Returns metadata for the specified folder. This
987+
operation is only applicable to a hierarchical namespace
988+
enabled bucket. Hierarchical namespace buckets are in
989+
allowlist preview.
968990
969991
.. code-block:: python
970992
@@ -994,7 +1016,11 @@ def sample_get_folder():
9941016
9951017
Args:
9961018
request (Union[google.cloud.storage_control_v2.types.GetFolderRequest, dict]):
997-
The request object. Request message for GetFolder.
1019+
The request object. Request message for GetFolder. This
1020+
operation is only applicable to a
1021+
hierarchical namespace enabled bucket.
1022+
Hierarchical namespace buckets are in
1023+
allowlist preview.
9981024
name (str):
9991025
Required. Name of the folder. Format:
10001026
``projects/{project}/buckets/{bucket}/folders/{folder}``
@@ -1010,7 +1036,11 @@ def sample_get_folder():
10101036
10111037
Returns:
10121038
google.cloud.storage_control_v2.types.Folder:
1013-
A folder.
1039+
A folder resource. This resource can
1040+
only exist in a hierarchical namespace
1041+
enabled bucket. Hierarchical namespace
1042+
buckets are in allowlist preview.
1043+
10141044
"""
10151045
# Create or coerce a protobuf request object.
10161046
# Quick check: If we got a request object, we should *not* have
@@ -1077,7 +1107,9 @@ def list_folders(
10771107
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
10781108
metadata: Sequence[Tuple[str, str]] = (),
10791109
) -> pagers.ListFoldersPager:
1080-
r"""Retrieves a list of folders for a given bucket.
1110+
r"""Retrieves a list of folders. This operation is only
1111+
applicable to a hierarchical namespace enabled bucket.
1112+
Hierarchical namespace buckets are in allowlist preview.
10811113
10821114
.. code-block:: python
10831115
@@ -1108,10 +1140,15 @@ def sample_list_folders():
11081140
11091141
Args:
11101142
request (Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]):
1111-
The request object. Request message for ListFolders.
1143+
The request object. Request message for ListFolders. This
1144+
operation is only applicable to a
1145+
hierarchical namespace enabled bucket.
1146+
Hierarchical namespace buckets are in
1147+
allowlist preview.
11121148
parent (str):
11131149
Required. Name of the bucket in which
1114-
to look for folders.
1150+
to look for folders. The bucket must be
1151+
a hierarchical namespace enabled bucket.
11151152
11161153
This corresponds to the ``parent`` field
11171154
on the ``request`` instance; if ``request`` is provided, this
@@ -1201,9 +1238,12 @@ def rename_folder(
12011238
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
12021239
metadata: Sequence[Tuple[str, str]] = (),
12031240
) -> operation.Operation:
1204-
r"""Renames a source folder to a destination folder.
1205-
During a rename, the source and destination folders are
1206-
locked until the long running operation completes.
1241+
r"""Renames a source folder to a destination folder. This
1242+
operation is only applicable to a hierarchical namespace
1243+
enabled bucket. During a rename, the source and
1244+
destination folders are locked until the long running
1245+
operation completes.
1246+
Hierarchical namespace buckets are in allowlist preview.
12071247
12081248
.. code-block:: python
12091249
@@ -1239,6 +1279,10 @@ def sample_rename_folder():
12391279
Args:
12401280
request (Union[google.cloud.storage_control_v2.types.RenameFolderRequest, dict]):
12411281
The request object. Request message for RenameFolder.
1282+
This operation is only applicable to a
1283+
hierarchical namespace enabled bucket.
1284+
Hierarchical namespace buckets are in
1285+
allowlist preview.
12421286
name (str):
12431287
Required. Name of the source folder being renamed.
12441288
Format:
@@ -1262,9 +1306,9 @@ def sample_rename_folder():
12621306
google.api_core.operation.Operation:
12631307
An object representing a long-running operation.
12641308
1265-
The result type for the operation will be
1266-
:class:`google.cloud.storage_control_v2.types.Folder` A
1267-
folder.
1309+
The result type for the operation will be :class:`google.cloud.storage_control_v2.types.Folder` A folder resource. This resource can only exist in a hierarchical namespace
1310+
enabled bucket. Hierarchical namespace buckets are in
1311+
allowlist preview.
12681312
12691313
"""
12701314
# Create or coerce a protobuf request object.

0 commit comments

Comments
 (0)