Class StorageTransferServiceAsyncClient (1.1.1)

StorageTransferServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport] = 'grpc_asyncio', client_options: 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>)

Storage Transfer Service and its protos. Transfers data between between Google Cloud Storage buckets or from a data source external to Google to a Cloud Storage bucket.

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
StorageTransferServiceTransportThe transport used by the client instance.

Methods

StorageTransferServiceAsyncClient

StorageTransferServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport] = 'grpc_asyncio', client_options: 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 transfer service 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, .StorageTransferServiceTransport]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS 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.

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)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_transfer_job

create_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.CreateTransferJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a transfer job that runs periodically.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.CreateTransferJobRequest, dict]

The request object. Request passed to CreateTransferJob.

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
TypeDescription
google.cloud.storage_transfer_v1.types.TransferJobThis resource represents the configuration of a transfer job that runs periodically.

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
StorageTransferServiceAsyncClientThe 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
StorageTransferServiceAsyncClientThe 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
StorageTransferServiceAsyncClientThe constructed client.

get_google_service_account

get_google_service_account(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetGoogleServiceAccountRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Returns the Google service account that is used by Storage Transfer Service to access buckets in the project where transfers run or in other projects. Each Google service account is associated with one Google Cloud Platform Console project. Users should add this service account to the Google Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This service account is created and owned by Storage Transfer Service and can only be used by Storage Transfer Service.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.GetGoogleServiceAccountRequest, dict]

The request object. Request passed to GetGoogleServiceAccount.

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
TypeDescription
google.cloud.storage_transfer_v1.types.GoogleServiceAccountGoogle service account

get_transfer_job

get_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetTransferJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a transfer job.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.GetTransferJobRequest, dict]

The request object. Request passed to GetTransferJob.

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
TypeDescription
google.cloud.storage_transfer_v1.types.TransferJobThis resource represents the configuration of a transfer job that runs periodically.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_transfer_jobs

list_transfer_jobs(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists transfer jobs.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.ListTransferJobsRequest, dict]

The request object. projectId, jobNames, and jobStatuses are query parameters that can be specified when listing transfer jobs.

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
TypeDescription
google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPagerResponse from ListTransferJobs. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

pause_transfer_operation

pause_transfer_operation(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.PauseTransferOperationRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Pauses a transfer operation.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.PauseTransferOperationRequest, dict]

The request object. Request passed to PauseTransferOperation.

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.

resume_transfer_operation

resume_transfer_operation(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ResumeTransferOperationRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Resumes a transfer operation that is paused.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.ResumeTransferOperationRequest, dict]

The request object. Request passed to ResumeTransferOperation.

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.

run_transfer_job

run_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.RunTransferJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Attempts to start a new TransferOperation for the current TransferJob. A TransferJob has a maximum of one active TransferOperation. If this method is called while a TransferOperation is active, an error wil be returned.

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.RunTransferJobRequest, dict]

The request object. Request passed to RunTransferJob.

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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

update_transfer_job

update_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.UpdateTransferJobRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already.

Note: The job's status][google.storagetransfer.v1.TransferJob.status] field can be modified using this RPC (for example, to set a job's status to DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED], DISABLED][google.storagetransfer.v1.TransferJob.Status.DISABLED], or ENABLED][google.storagetransfer.v1.TransferJob.Status.ENABLED]).

Parameters
NameDescription
request Union[google.cloud.storage_transfer_v1.types.UpdateTransferJobRequest, dict]

The request object. Request passed to UpdateTransferJob.

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
TypeDescription
google.cloud.storage_transfer_v1.types.TransferJobThis resource represents the configuration of a transfer job that runs periodically.