Package Methods (1.11.4)

Summary of entries of Methods for storagetransfer.

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient

StorageTransferServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport, typing.Callable[[...], google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =

Instantiates the storage transfer service async client.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.agent_pools_path

agent_pools_path(project_id: str, agent_pool_id: str) -> str

Returns a fully-qualified agent_pools string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.agent_pools_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.cancel_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_billing_account_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_folder_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_location_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_organization_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.common_project_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.create_agent_pool

create_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.CreateAgentPoolRequest, dict
        ]
    ] = None,
    *,
    project_id: typing.Optional[str] = None,
    agent_pool: typing.Optional[
        google.cloud.storage_transfer_v1.types.transfer_types.AgentPool
    ] = None,
    agent_pool_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_transfer_v1.types.transfer_types.AgentPool

Creates an agent pool resource.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.create_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.create_transfer_job

create_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.CreateTransferJobRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Creates a transfer job that runs periodically.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.create_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.delete_agent_pool

delete_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.DeleteAgentPoolRequest, 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

Deletes an agent pool.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.delete_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.delete_transfer_job

delete_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.DeleteTransferJobRequest,
            dict,
        ]
    ] = 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

Deletes a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.delete_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_file

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_file

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_info

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_info

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_json

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.from_service_account_json

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_agent_pool

get_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetAgentPoolRequest, 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_transfer_v1.types.transfer_types.AgentPool

Gets an agent pool.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_google_service_account

get_google_service_account(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetGoogleServiceAccountRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.GoogleServiceAccount

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.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_google_service_account

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.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.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_mtls_endpoint_and_cert_source

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_transfer_job

get_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetTransferJobRequest, dict
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Gets a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_transport_class

get_transport_class() -> (
    typing.Type[
        google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport
    ]
)

Returns an appropriate transport class.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.get_transport_class

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_agent_pools

list_agent_pools(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest, dict
        ]
    ] = None,
    *,
    project_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_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager
)

Lists agent pools.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_agent_pools

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_operations

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_transfer_jobs

list_transfer_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
            dict,
        ]
    ] = 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_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager
)

Lists transfer jobs.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.list_transfer_jobs

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_agent_pools_path

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

Parses a agent_pools path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_agent_pools_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.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.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_billing_account_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_folder_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_location_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_organization_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.parse_common_project_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.pause_transfer_operation

pause_transfer_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.PauseTransferOperationRequest,
            dict,
        ]
    ] = 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

Pauses a transfer operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.pause_transfer_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.resume_transfer_operation

resume_transfer_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ResumeTransferOperationRequest,
            dict,
        ]
    ] = 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

Resumes a transfer operation that is paused.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.resume_transfer_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.run_transfer_job

run_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.RunTransferJobRequest, dict
        ]
    ] = 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

Starts a new operation for the specified transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.run_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.update_agent_pool

update_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.UpdateAgentPoolRequest, dict
        ]
    ] = None,
    *,
    agent_pool: typing.Optional[
        google.cloud.storage_transfer_v1.types.transfer_types.AgentPool
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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_transfer_v1.types.transfer_types.AgentPool

Updates an existing agent pool resource.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.update_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.update_transfer_job

update_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.UpdateTransferJobRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Updates a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceAsyncClient.update_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient

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

Instantiates the storage transfer service client.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.exit

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.agent_pools_path

agent_pools_path(project_id: str, agent_pool_id: str) -> str

Returns a fully-qualified agent_pools string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.agent_pools_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.cancel_operation

cancel_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.CancelOperationRequest
    ] = 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

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.cancel_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_billing_account_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_folder_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_location_path

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

Returns a fully-qualified location string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_location_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_organization_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.common_project_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.create_agent_pool

create_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.CreateAgentPoolRequest, dict
        ]
    ] = None,
    *,
    project_id: typing.Optional[str] = None,
    agent_pool: typing.Optional[
        google.cloud.storage_transfer_v1.types.transfer_types.AgentPool
    ] = None,
    agent_pool_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_transfer_v1.types.transfer_types.AgentPool

Creates an agent pool resource.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.create_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.create_transfer_job

create_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.CreateTransferJobRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Creates a transfer job that runs periodically.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.create_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.delete_agent_pool

delete_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.DeleteAgentPoolRequest, 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

Deletes an agent pool.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.delete_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.delete_transfer_job

delete_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.DeleteTransferJobRequest,
            dict,
        ]
    ] = 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

Deletes a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.delete_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_file

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_file

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_info

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_info

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_json

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

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

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.from_service_account_json

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_agent_pool

get_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetAgentPoolRequest, 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_transfer_v1.types.transfer_types.AgentPool

Gets an agent pool.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_google_service_account

get_google_service_account(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetGoogleServiceAccountRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.GoogleServiceAccount

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.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_google_service_account

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_mtls_endpoint_and_cert_source

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

Deprecated.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_mtls_endpoint_and_cert_source

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = 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.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_transfer_job

get_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.GetTransferJobRequest, dict
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Gets a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.get_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_agent_pools

list_agent_pools(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest, dict
        ]
    ] = None,
    *,
    project_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_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager
)

Lists agent pools.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_agent_pools

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_operations

list_operations(
    request: typing.Optional[
        google.longrunning.operations_pb2.ListOperationsRequest
    ] = 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.longrunning.operations_pb2.ListOperationsResponse

Lists operations that match the specified filter in the request.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_operations

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_transfer_jobs

list_transfer_jobs(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
            dict,
        ]
    ] = 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_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager
)

Lists transfer jobs.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.list_transfer_jobs

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_agent_pools_path

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

Parses a agent_pools path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_agent_pools_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.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.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_billing_account_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_folder_path

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

Parse a folder path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_folder_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_location_path

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

Parse a location path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_location_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_organization_path

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

Parse a organization path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_organization_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_project_path

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

Parse a project path into its component segments.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.parse_common_project_path

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.pause_transfer_operation

pause_transfer_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.PauseTransferOperationRequest,
            dict,
        ]
    ] = 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

Pauses a transfer operation.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.pause_transfer_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.resume_transfer_operation

resume_transfer_operation(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.ResumeTransferOperationRequest,
            dict,
        ]
    ] = 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

Resumes a transfer operation that is paused.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.resume_transfer_operation

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.run_transfer_job

run_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.RunTransferJobRequest, dict
        ]
    ] = 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

Starts a new operation for the specified transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.run_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.update_agent_pool

update_agent_pool(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.UpdateAgentPoolRequest, dict
        ]
    ] = None,
    *,
    agent_pool: typing.Optional[
        google.cloud.storage_transfer_v1.types.transfer_types.AgentPool
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = 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_transfer_v1.types.transfer_types.AgentPool

Updates an existing agent pool resource.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.update_agent_pool

google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.update_transfer_job

update_transfer_job(
    request: typing.Optional[
        typing.Union[
            google.cloud.storage_transfer_v1.types.transfer.UpdateTransferJobRequest,
            dict,
        ]
    ] = 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_transfer_v1.types.transfer_types.TransferJob

Updates a transfer job.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.StorageTransferServiceClient.update_transfer_job

google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager

ListAgentPoolsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse
        ],
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager

google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager

ListAgentPoolsPager(
    method: typing.Callable[
        [...], google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager

google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager

ListTransferJobsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse
        ],
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiates the pager.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager

google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager

ListTransferJobsPager(
    method: typing.Callable[
        [...], google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse
    ],
    request: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest,
    response: google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

Instantiate the pager.

See more: google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager