Class StorageControlClient (1.0.0)

StorageControlClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport, typing.Callable[[...], google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

StorageControl service includes selected control plane operations.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
StorageControlTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

StorageControlClient

StorageControlClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport, typing.Callable[[...], google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the storage control client.

Parameters
Name Description
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Optional[Union[str,StorageControlTransport,Callable[..., StorageControlTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the StorageControlTransport constructor. If set to None, a transport is chosen automatically.

client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_folder

create_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.CreateFolderRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    folder: typing.Optional[
        google.cloud.storage_control_v2.types.storage_control.Folder
    ] = None,
    folder_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.types.storage_control.Folder

Creates a new folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_create_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.CreateFolderRequest(
        parent="parent_value",
        folder_id="folder_id_value",
    )

    # Make the request
    response = client.create_folder(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
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 bucket must be a hierarchical namespace enabled bucket. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

folder google.cloud.storage_control_v2.types.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. This corresponds to the folder field on the request instance; if request is provided, this should not be set.

folder_id str

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. This corresponds to the folder_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
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_managed_folder

create_managed_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.CreateManagedFolderRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    managed_folder: typing.Optional[
        google.cloud.storage_control_v2.types.storage_control.ManagedFolder
    ] = None,
    managed_folder_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.types.storage_control.ManagedFolder

Creates a new managed folder.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_create_managed_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.CreateManagedFolderRequest(
        parent="parent_value",
        managed_folder_id="managed_folder_id_value",
    )

    # Make the request
    response = client.create_managed_folder(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.CreateManagedFolderRequest, dict]

The request object. Request message for CreateManagedFolder.

parent str

Required. Name of the bucket this managed folder belongs to. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

managed_folder google.cloud.storage_control_v2.types.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. This corresponds to the managed_folder field on the request instance; if request is provided, this should not be set.

managed_folder_id str

Required. The name of the managed folder. It uses a single / as delimiter and leading and trailing / are allowed. This corresponds to the managed_folder_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.storage_control_v2.types.ManagedFolder A managed folder.

delete_folder

delete_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.DeleteFolderRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Permanently deletes an empty folder. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_delete_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.DeleteFolderRequest(
        name="name_value",
    )

    # Make the request
    client.delete_folder(request=request)
Parameters
Name Description
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} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

delete_managed_folder

delete_managed_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.DeleteManagedFolderRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None

Permanently deletes an empty managed folder.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_delete_managed_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.DeleteManagedFolderRequest(
        name="name_value",
    )

    # Make the request
    client.delete_managed_folder(request=request)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.DeleteManagedFolderRequest, dict]

The request object. DeleteManagedFolder RPC request message.

name str

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

folder_path

folder_path(project: str, bucket: str, folder: str) -> str

Returns a fully-qualified folder string.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
StorageControlClient The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name Description
info dict

The service account private key info.

Returns
Type Description
StorageControlClient The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name Description
filename str

The path to the service account private key json file.

Returns
Type Description
StorageControlClient The constructed client.

get_folder

get_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.GetFolderRequest, dict
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.types.storage_control.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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_get_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.GetFolderRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_folder(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.GetFolderRequest, dict]

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} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
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.

get_managed_folder

get_managed_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.GetManagedFolderRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.types.storage_control.ManagedFolder

Returns metadata for the specified managed folder.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_get_managed_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.GetManagedFolderRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_managed_folder(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.GetManagedFolderRequest, dict]

The request object. Request message for GetManagedFolder.

name str

Required. Name of the managed folder. Format: projects/{project}/buckets/{bucket}/managedFolders/{managedFolder} This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.storage_control_v2.types.ManagedFolder A managed folder.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_storage_layout

get_storage_layout(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.GetStorageLayoutRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.types.storage_control.StorageLayout

Returns the storage layout configuration for a given bucket.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_get_storage_layout():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.GetStorageLayoutRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_storage_layout(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.GetStorageLayoutRequest, dict]

The request object. Request message for GetStorageLayout.

name str

Required. The name of the StorageLayout resource. Format: projects/{project}/buckets/{bucket}/storageLayout This corresponds to the name field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.storage_control_v2.types.StorageLayout The storage layout configuration of a bucket.

list_folders

list_folders(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.ListFoldersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.storage_control_v2.services.storage_control.pagers.ListFoldersPager

Retrieves a list of folders. This operation is only applicable to a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_list_folders():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.ListFoldersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_folders(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]

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. The bucket must be a hierarchical namespace enabled bucket. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.storage_control_v2.services.storage_control.pagers.ListFoldersPager Response message for ListFolders. Iterating over this object will yield results and resolve additional pages automatically.

list_managed_folders

list_managed_folders(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.ListManagedFoldersRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.storage_control_v2.services.storage_control.pagers.ListManagedFoldersPager
)

Retrieves a list of managed folders for a given bucket.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_list_managed_folders():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.ListManagedFoldersRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_managed_folders(request=request)

    # Handle the response
    for response in page_result:
        print(response)
Parameters
Name Description
request Union[google.cloud.storage_control_v2.types.ListManagedFoldersRequest, dict]

The request object. Request message for ListManagedFolders.

parent str

Required. Name of the bucket this managed folder belongs to. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.cloud.storage_control_v2.services.storage_control.pagers.ListManagedFoldersPager Response message for ListManagedFolders. Iterating over this object will yield results and resolve additional pages automatically.

managed_folder_path

managed_folder_path(project: str, bucket: str, managed_folder: str) -> str

Returns a fully-qualified managed_folder string.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_folder_path

parse_folder_path(path: str) -> typing.Dict[str, str]

Parses a folder path into its component segments.

parse_managed_folder_path

parse_managed_folder_path(path: str) -> typing.Dict[str, str]

Parses a managed_folder path into its component segments.

parse_storage_layout_path

parse_storage_layout_path(path: str) -> typing.Dict[str, str]

Parses a storage_layout path into its component segments.

rename_folder

rename_folder(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_control_v2.types.storage_control.RenameFolderRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    destination_folder_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import storage_control_v2

def sample_rename_folder():
    # Create a client
    client = storage_control_v2.StorageControlClient()

    # Initialize request argument(s)
    request = storage_control_v2.RenameFolderRequest(
        name="name_value",
        destination_folder_id="destination_folder_id_value",
    )

    # Make the request
    operation = client.rename_folder(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)
Parameters
Name Description
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: projects/{project}/buckets/{bucket}/folders/{folder} This corresponds to the name field on the request instance; if request is provided, this should not be set.

destination_folder_id str

Required. The destination folder ID, e.g. foo/bar/. This corresponds to the destination_folder_id field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry.Retry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.

Returns
Type Description
google.api_core.operation.Operation An object representing a long-running operation. The result type for the operation will be Folder A folder resource. This resource can only exist in a hierarchical namespace enabled bucket. Hierarchical namespace buckets are in allowlist preview.

storage_layout_path

storage_layout_path(project: str, bucket: str) -> str

Returns a fully-qualified storage_layout string.