Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [google-cloud-storage-control] update storage control documentation #12594

Merged
merged 2 commits into from
Apr 19, 2024
Merged

docs: [google-cloud-storage-control] update storage control documentation #12594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daf5212
docs: update storage control documentation and add PHP for publishing
gcf-owl-bot[bot] Apr 18, 2024
9a5175c
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Apr 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/google-cloud-storage-control/google/cloud/storage_control/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.1.2" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
2 changes: 1 addition & 1 deletion packages/google-cloud-storage-control/google/cloud/storage_control_v2/gapic_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@
# See the License for the specific language governing permissions and
# limitations under the License.
#
__version__ = "0.1.2" # {x-release-please-version}
__version__ = "0.0.0" # {x-release-please-version}
76 changes: 60 additions & 16 deletions ...-storage-control/google/cloud/storage_control_v2/services/storage_control/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,9 @@ async def create_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> storage_control.Folder:
r"""Creates a new folder.
r"""Creates a new folder. This operation is only
applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -311,9 +313,15 @@ async def sample_create_folder():
Args:
request (Optional[Union[google.cloud.storage_control_v2.types.CreateFolderRequest, dict]]):
The request object. Request message for CreateFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
parent (:class:`str`):
Required. Name of the bucket in which
the folder will reside.
the folder will reside. The bucket must
be a hierarchical namespace enabled
bucket.

This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -346,7 +354,11 @@ async def sample_create_folder():

Returns:
google.cloud.storage_control_v2.types.Folder:
A folder.
A folder resource. This resource can
only exist in a hierarchical namespace
enabled bucket. Hierarchical namespace
buckets are in allowlist preview.

"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
Expand Down Expand Up @@ -403,7 +415,10 @@ async def delete_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes an empty folder.
r"""Permanently deletes an empty folder. This operation
is only applicable to a hierarchical namespace enabled
bucket. Hierarchical namespace buckets are in allowlist
preview.

.. code-block:: python

Expand Down Expand Up @@ -431,6 +446,10 @@ async def sample_delete_folder():
Args:
request (Optional[Union[google.cloud.storage_control_v2.types.DeleteFolderRequest, dict]]):
The request object. Request message for DeleteFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (:class:`str`):
Required. Name of the folder. Format:
``projects/{project}/buckets/{bucket}/folders/{folder}``
Expand Down Expand Up @@ -492,7 +511,10 @@ async def get_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> storage_control.Folder:
r"""Returns metadata for the specified folder.
r"""Returns metadata for the specified folder. This
operation is only applicable to a hierarchical namespace
enabled bucket. Hierarchical namespace buckets are in
allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -522,7 +544,11 @@ async def sample_get_folder():

Args:
request (Optional[Union[google.cloud.storage_control_v2.types.GetFolderRequest, dict]]):
The request object. Request message for GetFolder.
The request object. Request message for GetFolder. This
operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (:class:`str`):
Required. Name of the folder. Format:
``projects/{project}/buckets/{bucket}/folders/{folder}``
Expand All @@ -538,7 +564,11 @@ async def sample_get_folder():

Returns:
google.cloud.storage_control_v2.types.Folder:
A folder.
A folder resource. This resource can
only exist in a hierarchical namespace
enabled bucket. Hierarchical namespace
buckets are in allowlist preview.

"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
Expand Down Expand Up @@ -604,7 +634,9 @@ async def list_folders(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListFoldersAsyncPager:
r"""Retrieves a list of folders for a given bucket.
r"""Retrieves a list of folders. This operation is only
applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -635,10 +667,15 @@ async def sample_list_folders():

Args:
request (Optional[Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]]):
The request object. Request message for ListFolders.
The request object. Request message for ListFolders. This
operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
parent (:class:`str`):
Required. Name of the bucket in which
to look for folders.
to look for folders. The bucket must be
a hierarchical namespace enabled bucket.

This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -729,9 +766,12 @@ async def rename_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Renames a source folder to a destination folder.
During a rename, the source and destination folders are
locked until the long running operation completes.
r"""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.

.. code-block:: python

Expand Down Expand Up @@ -767,6 +807,10 @@ async def sample_rename_folder():
Args:
request (Optional[Union[google.cloud.storage_control_v2.types.RenameFolderRequest, dict]]):
The request object. Request message for RenameFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (:class:`str`):
Required. Name of the source folder being renamed.
Format:
Expand All @@ -790,9 +834,9 @@ async def sample_rename_folder():
google.api_core.operation_async.AsyncOperation:
An object representing a long-running operation.

The result type for the operation will be
:class:`google.cloud.storage_control_v2.types.Folder` A
folder.
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
enabled bucket. Hierarchical namespace buckets are in
allowlist preview.

"""
# Create or coerce a protobuf request object.
Expand Down
76 changes: 60 additions & 16 deletions ...-cloud-storage-control/google/cloud/storage_control_v2/services/storage_control/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -725,7 +725,9 @@ def create_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> storage_control.Folder:
r"""Creates a new folder.
r"""Creates a new folder. This operation is only
applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -757,9 +759,15 @@ def sample_create_folder():
Args:
request (Union[google.cloud.storage_control_v2.types.CreateFolderRequest, dict]):
The request object. Request message for CreateFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
parent (str):
Required. Name of the bucket in which
the folder will reside.
the folder will reside. The bucket must
be a hierarchical namespace enabled
bucket.

This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -792,7 +800,11 @@ def sample_create_folder():

Returns:
google.cloud.storage_control_v2.types.Folder:
A folder.
A folder resource. This resource can
only exist in a hierarchical namespace
enabled bucket. Hierarchical namespace
buckets are in allowlist preview.

"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
Expand Down Expand Up @@ -861,7 +873,10 @@ def delete_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> None:
r"""Permanently deletes an empty folder.
r"""Permanently deletes an empty folder. This operation
is only applicable to a hierarchical namespace enabled
bucket. Hierarchical namespace buckets are in allowlist
preview.

.. code-block:: python

Expand Down Expand Up @@ -889,6 +904,10 @@ def sample_delete_folder():
Args:
request (Union[google.cloud.storage_control_v2.types.DeleteFolderRequest, dict]):
The request object. Request message for DeleteFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (str):
Required. Name of the folder. Format:
``projects/{project}/buckets/{bucket}/folders/{folder}``
Expand Down Expand Up @@ -964,7 +983,10 @@ def get_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> storage_control.Folder:
r"""Returns metadata for the specified folder.
r"""Returns metadata for the specified folder. This
operation is only applicable to a hierarchical namespace
enabled bucket. Hierarchical namespace buckets are in
allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -994,7 +1016,11 @@ def sample_get_folder():

Args:
request (Union[google.cloud.storage_control_v2.types.GetFolderRequest, dict]):
The request object. Request message for GetFolder.
The request object. Request message for GetFolder. This
operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (str):
Required. Name of the folder. Format:
``projects/{project}/buckets/{bucket}/folders/{folder}``
Expand All @@ -1010,7 +1036,11 @@ def sample_get_folder():

Returns:
google.cloud.storage_control_v2.types.Folder:
A folder.
A folder resource. This resource can
only exist in a hierarchical namespace
enabled bucket. Hierarchical namespace
buckets are in allowlist preview.

"""
# Create or coerce a protobuf request object.
# Quick check: If we got a request object, we should *not* have
Expand Down Expand Up @@ -1077,7 +1107,9 @@ def list_folders(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListFoldersPager:
r"""Retrieves a list of folders for a given bucket.
r"""Retrieves a list of folders. This operation is only
applicable to a hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.

.. code-block:: python

Expand Down Expand Up @@ -1108,10 +1140,15 @@ def sample_list_folders():

Args:
request (Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]):
The request object. Request message for ListFolders.
The request object. Request message for ListFolders. This
operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
parent (str):
Required. Name of the bucket in which
to look for folders.
to look for folders. The bucket must be
a hierarchical namespace enabled bucket.

This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1201,9 +1238,12 @@ def rename_folder(
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Renames a source folder to a destination folder.
During a rename, the source and destination folders are
locked until the long running operation completes.
r"""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.

.. code-block:: python

Expand Down Expand Up @@ -1239,6 +1279,10 @@ def sample_rename_folder():
Args:
request (Union[google.cloud.storage_control_v2.types.RenameFolderRequest, dict]):
The request object. Request message for RenameFolder.
This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in
allowlist preview.
name (str):
Required. Name of the source folder being renamed.
Format:
Expand All @@ -1262,9 +1306,9 @@ def sample_rename_folder():
google.api_core.operation.Operation:
An object representing a long-running operation.

The result type for the operation will be
:class:`google.cloud.storage_control_v2.types.Folder` A
folder.
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
enabled bucket. Hierarchical namespace buckets are in
allowlist preview.

"""
# Create or coerce a protobuf request object.
Expand Down
Loading
Loading