Class StorageControlAsyncClient (0.1.0)

StorageControlAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Union[str, google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = 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
TypeDescription
strThe API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
TypeDescription
StorageControlTransportThe transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
TypeDescription
strThe universe domain used by the client instance.

Methods

StorageControlAsyncClient

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

Instantiates the storage control async client.

Parameters
NameDescription
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 Union[str, .StorageControlTransport]

The transport to use. 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 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
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

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_async.AsyncRetry,
            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 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

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

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.storage_control_v2.types.CreateFolderRequest, dict]]

The request object. Request message for CreateFolder.

parent str

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

folder 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 absolute path of the folder, using a single / as delimiter. 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_async.AsyncRetry

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
TypeDescription
google.cloud.storage_control_v2.types.FolderA 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_async.AsyncRetry,
            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 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

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

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

    # Make the request
    await client.delete_folder(request=request)
Parameters
NameDescription
request Optional[Union[google.cloud.storage_control_v2.types.DeleteFolderRequest, dict]]

The request object. Request message for DeleteFolder.

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_async.AsyncRetry

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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
StorageControlAsyncClientThe 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
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
StorageControlAsyncClientThe 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
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
StorageControlAsyncClientThe 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_async.AsyncRetry,
            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 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

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

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

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

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

The request object. Request message for GetFolder.

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_async.AsyncRetry

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
TypeDescription
google.cloud.storage_control_v2.types.FolderA folder.

get_mtls_endpoint_and_cert_source

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

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
NameDescription
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
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
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_async.AsyncRetry,
            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

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

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

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

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[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_async.AsyncRetry

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
TypeDescription
google.cloud.storage_control_v2.types.StorageLayoutThe storage layout configuration of a bucket.

get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.storage_control_v2.services.storage_control.transports.base.StorageControlTransport
    ]
)

Returns an appropriate transport class.

Parameter
NameDescription
label typing.Optional[str]

The name of the desired transport. If none is provided, then the first transport in the registry is used.

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_async.AsyncRetry,
            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.ListFoldersAsyncPager
)

Retrieves a list of 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

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

    # 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
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.storage_control_v2.types.ListFoldersRequest, dict]]

The request object. Request message for ListFolders.

parent str

Required. Name of the bucket in which to look for folders. This corresponds to the parent field on the request instance; if request is provided, this should not be set.

retry google.api_core.retry_async.AsyncRetry

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
TypeDescription
google.cloud.storage_control_v2.services.storage_control.pagers.ListFoldersAsyncPagerResponse message for ListFolders. Iterating over this object will yield results and resolve additional pages automatically.

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_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_async.AsyncRetry,
            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_async.AsyncOperation

Renames a source folder to a destination folder. During a rename, the source and destination folders are locked until the long running operation completes.

# 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

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

    # 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 = (await operation).result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Optional[Union[google.cloud.storage_control_v2.types.RenameFolderRequest, dict]]

The request object. Request message for RenameFolder.

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_async.AsyncRetry

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Folder A folder.

storage_layout_path

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

Returns a fully-qualified storage_layout string.