StorageTransferService¶
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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.
Instantiates the storage transfer service async client.
- Parameters
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,StorageTransferServiceTransport,Callable[..., StorageTransferServiceTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the StorageTransferServiceTransport 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 whentransport
is not explicitly provided. Only if this property is not set andtransport
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 thatapi_endpoint
property still takes precedence; anduniverse_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- static agent_pools_path(project_id: str, agent_pool_id: str) str ¶
Returns a fully-qualified agent_pools string.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- async cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.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
None
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- async create_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.CreateAgentPoolRequest, dict]] = None, *, project_id: Optional[str] = None, agent_pool: Optional[google.cloud.storage_transfer_v1.types.transfer_types.AgentPool] = None, agent_pool_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Creates an agent pool resource.
# 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_transfer_v1 async def sample_create_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) agent_pool = storage_transfer_v1.AgentPool() agent_pool.name = "name_value" request = storage_transfer_v1.CreateAgentPoolRequest( project_id="project_id_value", agent_pool=agent_pool, agent_pool_id="agent_pool_id_value", ) # Make the request response = await client.create_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.CreateAgentPoolRequest, dict]]) – The request object. Specifies the request passed to CreateAgentPool.
project_id (
str
) –Required. The ID of the Google Cloud project that owns the agent pool.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.agent_pool (
google.cloud.storage_transfer_v1.types.AgentPool
) – Required. The agent pool to create. This corresponds to theagent_pool
field on therequest
instance; ifrequest
is provided, this should not be set.agent_pool_id (
str
) –Required. The ID of the agent pool to create.
The
agent_pool_id
must meet the following requirements:Length of 128 characters or less.
Not start with the string
goog
.Start with a lowercase ASCII character, followed by:
Zero or more: lowercase Latin alphabet characters, numerals, hyphens (
-
), periods (.
), underscores (_
), or tildes (~
).One or more numerals or lowercase ASCII characters.
As expressed by the regular expression:
^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$
.This corresponds to the
agent_pool_id
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- async create_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.CreateTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
Creates a transfer job that runs periodically.
# 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_transfer_v1 async def sample_create_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.CreateTransferJobRequest( ) # Make the request response = await client.create_transfer_job(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.CreateTransferJobRequest, dict]]) – The request object. Request passed to CreateTransferJob.
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- async delete_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.DeleteAgentPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an agent pool.
# 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_transfer_v1 async def sample_delete_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.DeleteAgentPoolRequest( name="name_value", ) # Make the request await client.delete_agent_pool(request=request)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.DeleteAgentPoolRequest, dict]]) – The request object. Specifies the request passed to DeleteAgentPool.
name (
str
) –Required. The name of the agent pool to delete.
This corresponds to the
name
field on therequest
instance; ifrequest
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.
- async delete_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.DeleteTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a transfer job. Deleting a transfer job sets its status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
# 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_transfer_v1 async def sample_delete_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.DeleteTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request await client.delete_transfer_job(request=request)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.DeleteTransferJobRequest, dict]]) – The request object. Request passed to DeleteTransferJob.
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.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetAgentPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Gets an agent pool.
# 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_transfer_v1 async def sample_get_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.GetAgentPoolRequest( name="name_value", ) # Make the request response = await client.get_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.GetAgentPoolRequest, dict]]) – The request object. Specifies the request passed to GetAgentPool.
name (
str
) –Required. The name of the agent pool to get.
This corresponds to the
name
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- async get_google_service_account(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetGoogleServiceAccountRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.GoogleServiceAccount [source]¶
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 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.
# 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_transfer_v1 async def sample_get_google_service_account(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.GetGoogleServiceAccountRequest( project_id="project_id_value", ) # Make the request response = await client.get_google_service_account(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.GetGoogleServiceAccountRequest, dict]]) – The request object. Request passed to GetGoogleServiceAccount.
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
Google service account
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- async get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.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
An
Operation
object.- Return type
Operation
- async get_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
Gets a transfer job.
# 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_transfer_v1 async def sample_get_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.GetTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request response = await client.get_transfer_job(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.GetTransferJobRequest, dict]]) – The request object. Request passed to GetTransferJob.
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- classmethod get_transport_class(label: Optional[str] = None) Type[google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async list_agent_pools(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest, dict]] = None, *, project_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager [source]¶
Lists agent pools.
# 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_transfer_v1 async def sample_list_agent_pools(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.ListAgentPoolsRequest( project_id="project_id_value", ) # Make the request page_result = client.list_agent_pools(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.ListAgentPoolsRequest, dict]]) – The request object. The request passed to ListAgentPools.
project_id (
str
) –Required. The ID of the Google Cloud project that owns the job.
This corresponds to the
project_id
field on therequest
instance; ifrequest
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
Response from ListAgentPools.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager
- async list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.ListOperationsResponse [source]¶
Lists operations that match the specified filter in the request.
- Parameters
request (
ListOperationsRequest
) – The request object. Request message for ListOperations method.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
Response message for
ListOperations
method.- Return type
ListOperationsResponse
- async list_transfer_jobs(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager [source]¶
Lists transfer jobs.
# 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_transfer_v1 async def sample_list_transfer_jobs(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.ListTransferJobsRequest( filter="filter_value", ) # Make the request page_result = client.list_transfer_jobs(request=request) # Handle the response async for response in page_result: print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.ListTransferJobsRequest, dict]]) – The request object.
projectId
,jobNames
, andjobStatuses
are query parameters that can be specified when listing transfer jobs.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
Response from ListTransferJobs.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager
- static parse_agent_pools_path(path: str) Dict[str, str] ¶
Parses a agent_pools path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- async pause_transfer_operation(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.PauseTransferOperationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Pauses a transfer operation.
# 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_transfer_v1 async def sample_pause_transfer_operation(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.PauseTransferOperationRequest( name="name_value", ) # Make the request await client.pause_transfer_operation(request=request)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.PauseTransferOperationRequest, dict]]) – The request object. Request passed to PauseTransferOperation.
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.
- async resume_transfer_operation(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ResumeTransferOperationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Resumes a transfer operation that is paused.
# 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_transfer_v1 async def sample_resume_transfer_operation(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.ResumeTransferOperationRequest( name="name_value", ) # Make the request await client.resume_transfer_operation(request=request)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.ResumeTransferOperationRequest, dict]]) – The request object. Request passed to ResumeTransferOperation.
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.
- async run_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.RunTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Starts a new operation for the specified transfer job. A
TransferJob
has a maximum of one activeTransferOperation
. If this method is called while aTransferOperation
is active, an error is returned.# 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_transfer_v1 async def sample_run_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.RunTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request operation = client.run_transfer_job(request=request) print("Waiting for operation to complete...") response = (await operation).result() # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.RunTransferJobRequest, dict]]) – The request object. Request passed to RunTransferJob.
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
An 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 result type for the operation will be
- Return type
- property transport: google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
StorageTransferServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
- The universe domain used
by the client instance.
- Return type
- async update_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.UpdateAgentPoolRequest, dict]] = None, *, agent_pool: Optional[google.cloud.storage_transfer_v1.types.transfer_types.AgentPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Updates an existing agent pool resource.
# 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_transfer_v1 async def sample_update_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) agent_pool = storage_transfer_v1.AgentPool() agent_pool.name = "name_value" request = storage_transfer_v1.UpdateAgentPoolRequest( agent_pool=agent_pool, ) # Make the request response = await client.update_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.UpdateAgentPoolRequest, dict]]) – The request object. Specifies the request passed to UpdateAgentPool.
agent_pool (
google.cloud.storage_transfer_v1.types.AgentPool
) –Required. The agent pool to update.
agent_pool
is expected to specify following fields:[name][google.storagetransfer.v1.AgentPool.name]
[display_name][google.storagetransfer.v1.AgentPool.display_name]
[bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit] An
UpdateAgentPoolRequest
with any other fields is rejected with the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
This corresponds to the
agent_pool
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (
google.protobuf.field_mask_pb2.FieldMask
) –The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in
agentPool
to update in this request. The followingagentPool
fields can be updated:[display_name][google.storagetransfer.v1.AgentPool.display_name]
[bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit]
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- async update_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.UpdateTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
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]).
# 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_transfer_v1 async def sample_update_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceAsyncClient() # Initialize request argument(s) request = storage_transfer_v1.UpdateTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request response = await client.update_transfer_job(request=request) # Handle the response print(response)
- Parameters
request (Optional[Union[google.cloud.storage_transfer_v1.types.UpdateTransferJobRequest, dict]]) – The request object. Request passed to UpdateTransferJob.
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.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 = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]¶
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.
Instantiates the storage transfer service client.
- Parameters
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,StorageTransferServiceTransport,Callable[..., StorageTransferServiceTransport]]]) – 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 StorageTransferServiceTransport 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 whentransport
is not explicitly provided. Only if this property is not set andtransport
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 theapi_endpoint
property still takes precedence; anduniverse_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- __exit__(type, value, traceback)[source]¶
Releases underlying transport’s resources.
Warning
ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!
- static agent_pools_path(project_id: str, agent_pool_id: str) str [source]¶
Returns a fully-qualified agent_pools string.
- property api_endpoint¶
Return the API endpoint used by the client instance.
- Returns
The API endpoint used by the client instance.
- Return type
- cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.
- Parameters
request (
CancelOperationRequest
) – The request object. Request message for CancelOperation method.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
None
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.CreateAgentPoolRequest, dict]] = None, *, project_id: Optional[str] = None, agent_pool: Optional[google.cloud.storage_transfer_v1.types.transfer_types.AgentPool] = None, agent_pool_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Creates an agent pool resource.
# 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_transfer_v1 def sample_create_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) agent_pool = storage_transfer_v1.AgentPool() agent_pool.name = "name_value" request = storage_transfer_v1.CreateAgentPoolRequest( project_id="project_id_value", agent_pool=agent_pool, agent_pool_id="agent_pool_id_value", ) # Make the request response = client.create_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.CreateAgentPoolRequest, dict]) – The request object. Specifies the request passed to CreateAgentPool.
project_id (str) –
Required. The ID of the Google Cloud project that owns the agent pool.
This corresponds to the
project_id
field on therequest
instance; ifrequest
is provided, this should not be set.agent_pool (google.cloud.storage_transfer_v1.types.AgentPool) – Required. The agent pool to create. This corresponds to the
agent_pool
field on therequest
instance; ifrequest
is provided, this should not be set.agent_pool_id (str) –
Required. The ID of the agent pool to create.
The
agent_pool_id
must meet the following requirements:Length of 128 characters or less.
Not start with the string
goog
.Start with a lowercase ASCII character, followed by:
Zero or more: lowercase Latin alphabet characters, numerals, hyphens (
-
), periods (.
), underscores (_
), or tildes (~
).One or more numerals or lowercase ASCII characters.
As expressed by the regular expression:
^(?!goog)[a-z]([a-z0-9-._~]*[a-z0-9])?$
.This corresponds to the
agent_pool_id
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- create_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.CreateTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
Creates a transfer job that runs periodically.
# 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_transfer_v1 def sample_create_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.CreateTransferJobRequest( ) # Make the request response = client.create_transfer_job(request=request) # Handle the response print(response)
- Parameters
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- delete_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.DeleteAgentPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes an agent pool.
# 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_transfer_v1 def sample_delete_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.DeleteAgentPoolRequest( name="name_value", ) # Make the request client.delete_agent_pool(request=request)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.DeleteAgentPoolRequest, dict]) – The request object. Specifies the request passed to DeleteAgentPool.
name (str) –
Required. The name of the agent pool to delete.
This corresponds to the
name
field on therequest
instance; ifrequest
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_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.DeleteTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Deletes a transfer job. Deleting a transfer job sets its status to [DELETED][google.storagetransfer.v1.TransferJob.Status.DELETED].
# 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_transfer_v1 def sample_delete_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.DeleteTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request client.delete_transfer_job(request=request)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.DeleteTransferJobRequest, dict]) – The request object. Request passed to DeleteTransferJob.
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.
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetAgentPoolRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Gets an agent pool.
# 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_transfer_v1 def sample_get_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.GetAgentPoolRequest( name="name_value", ) # Make the request response = client.get_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.GetAgentPoolRequest, dict]) – The request object. Specifies the request passed to GetAgentPool.
name (str) –
Required. The name of the agent pool to get.
This corresponds to the
name
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- get_google_service_account(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetGoogleServiceAccountRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.GoogleServiceAccount [source]¶
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 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.
# 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_transfer_v1 def sample_get_google_service_account(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.GetGoogleServiceAccountRequest( project_id="project_id_value", ) # Make the request response = client.get_google_service_account(request=request) # Handle the response print(response)
- Parameters
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
Google service account
- Return type
- classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)[source]¶
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.
- Parameters
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.
- Returns
- returns the API endpoint and the
client cert source to use.
- Return type
- Raises
google.auth.exceptions.MutualTLSChannelError – If any errors happen.
- get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.Operation [source]¶
Gets the latest state of a long-running operation.
- Parameters
request (
GetOperationRequest
) – The request object. Request message for GetOperation method.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
An
Operation
object.- Return type
Operation
- get_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.GetTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
Gets a transfer job.
# 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_transfer_v1 def sample_get_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.GetTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request response = client.get_transfer_job(request=request) # Handle the response print(response)
- Parameters
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- list_agent_pools(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ListAgentPoolsRequest, dict]] = None, *, project_id: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager [source]¶
Lists agent pools.
# 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_transfer_v1 def sample_list_agent_pools(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.ListAgentPoolsRequest( project_id="project_id_value", ) # Make the request page_result = client.list_agent_pools(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.ListAgentPoolsRequest, dict]) – The request object. The request passed to ListAgentPools.
project_id (str) –
Required. The ID of the Google Cloud project that owns the job.
This corresponds to the
project_id
field on therequest
instance; ifrequest
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
Response from ListAgentPools.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager
- list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.longrunning.operations_pb2.ListOperationsResponse [source]¶
Lists operations that match the specified filter in the request.
- Parameters
request (
ListOperationsRequest
) – The request object. Request message for ListOperations method.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
Response message for
ListOperations
method.- Return type
ListOperationsResponse
- list_transfer_jobs(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ListTransferJobsRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager [source]¶
Lists transfer jobs.
# 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_transfer_v1 def sample_list_transfer_jobs(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.ListTransferJobsRequest( filter="filter_value", ) # Make the request page_result = client.list_transfer_jobs(request=request) # Handle the response for response in page_result: print(response)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.ListTransferJobsRequest, dict]) – The request object.
projectId
,jobNames
, andjobStatuses
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
Response from ListTransferJobs.
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager
- static parse_agent_pools_path(path: str) Dict[str, str] [source]¶
Parses a agent_pools path into its component segments.
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- pause_transfer_operation(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.PauseTransferOperationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Pauses a transfer operation.
# 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_transfer_v1 def sample_pause_transfer_operation(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.PauseTransferOperationRequest( name="name_value", ) # Make the request client.pause_transfer_operation(request=request)
- Parameters
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(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.ResumeTransferOperationRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) None [source]¶
Resumes a transfer operation that is paused.
# 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_transfer_v1 def sample_resume_transfer_operation(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.ResumeTransferOperationRequest( name="name_value", ) # Make the request client.resume_transfer_operation(request=request)
- Parameters
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(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.RunTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Starts a new operation for the specified transfer job. A
TransferJob
has a maximum of one activeTransferOperation
. If this method is called while aTransferOperation
is active, an error is returned.# 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_transfer_v1 def sample_run_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.RunTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request operation = client.run_transfer_job(request=request) print("Waiting for operation to complete...") response = operation.result() # Handle the response print(response)
- Parameters
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
An 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 result type for the operation will be
- Return type
- property transport: google.cloud.storage_transfer_v1.services.storage_transfer_service.transports.base.StorageTransferServiceTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
StorageTransferServiceTransport
- property universe_domain: str¶
Return the universe domain used by the client instance.
- Returns
The universe domain used by the client instance.
- Return type
- update_agent_pool(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.UpdateAgentPoolRequest, dict]] = None, *, agent_pool: Optional[google.cloud.storage_transfer_v1.types.transfer_types.AgentPool] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.AgentPool [source]¶
Updates an existing agent pool resource.
# 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_transfer_v1 def sample_update_agent_pool(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) agent_pool = storage_transfer_v1.AgentPool() agent_pool.name = "name_value" request = storage_transfer_v1.UpdateAgentPoolRequest( agent_pool=agent_pool, ) # Make the request response = client.update_agent_pool(request=request) # Handle the response print(response)
- Parameters
request (Union[google.cloud.storage_transfer_v1.types.UpdateAgentPoolRequest, dict]) – The request object. Specifies the request passed to UpdateAgentPool.
agent_pool (google.cloud.storage_transfer_v1.types.AgentPool) –
Required. The agent pool to update.
agent_pool
is expected to specify following fields:[name][google.storagetransfer.v1.AgentPool.name]
[display_name][google.storagetransfer.v1.AgentPool.display_name]
[bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit] An
UpdateAgentPoolRequest
with any other fields is rejected with the error [INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT].
This corresponds to the
agent_pool
field on therequest
instance; ifrequest
is provided, this should not be set.update_mask (google.protobuf.field_mask_pb2.FieldMask) –
The [field mask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf) of the fields in
agentPool
to update in this request. The followingagentPool
fields can be updated:[display_name][google.storagetransfer.v1.AgentPool.display_name]
[bandwidth_limit][google.storagetransfer.v1.AgentPool.bandwidth_limit]
This corresponds to the
update_mask
field on therequest
instance; ifrequest
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
Represents an agent pool.
- Return type
- update_transfer_job(request: Optional[Union[google.cloud.storage_transfer_v1.types.transfer.UpdateTransferJobRequest, dict]] = None, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.storage_transfer_v1.types.transfer_types.TransferJob [source]¶
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]).
# 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_transfer_v1 def sample_update_transfer_job(): # Create a client client = storage_transfer_v1.StorageTransferServiceClient() # Initialize request argument(s) request = storage_transfer_v1.UpdateTransferJobRequest( job_name="job_name_value", project_id="project_id_value", ) # Make the request response = client.update_transfer_job(request=request) # Handle the response print(response)
- Parameters
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
This resource represents the configuration of a transfer job that runs periodically.
- Return type
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsAsyncPager(method: Callable[[...], 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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_agent_pools
requests.This class thinly wraps an initial
google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse
object, and provides an__aiter__
method to iterate through itsagent_pools
field.If there are more pages, the
__aiter__
method will make additionalListAgentPools
requests and continue to iterate through theagent_pools
field on the corresponding responses.All the usual
google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.storage_transfer_v1.types.ListAgentPoolsRequest) – The initial request object.
response (google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse) – The initial response object.
retry (google.api_core.retry.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.
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListAgentPoolsPager(method: 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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_agent_pools
requests.This class thinly wraps an initial
google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse
object, and provides an__iter__
method to iterate through itsagent_pools
field.If there are more pages, the
__iter__
method will make additionalListAgentPools
requests and continue to iterate through theagent_pools
field on the corresponding responses.All the usual
google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.storage_transfer_v1.types.ListAgentPoolsRequest) – The initial request object.
response (google.cloud.storage_transfer_v1.types.ListAgentPoolsResponse) – The initial response object.
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.
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsAsyncPager(method: Callable[[...], 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, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_transfer_jobs
requests.This class thinly wraps an initial
google.cloud.storage_transfer_v1.types.ListTransferJobsResponse
object, and provides an__aiter__
method to iterate through itstransfer_jobs
field.If there are more pages, the
__aiter__
method will make additionalListTransferJobs
requests and continue to iterate through thetransfer_jobs
field on the corresponding responses.All the usual
google.cloud.storage_transfer_v1.types.ListTransferJobsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.storage_transfer_v1.types.ListTransferJobsRequest) – The initial request object.
response (google.cloud.storage_transfer_v1.types.ListTransferJobsResponse) – The initial response object.
retry (google.api_core.retry.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.
- class google.cloud.storage_transfer_v1.services.storage_transfer_service.pagers.ListTransferJobsPager(method: 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, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_transfer_jobs
requests.This class thinly wraps an initial
google.cloud.storage_transfer_v1.types.ListTransferJobsResponse
object, and provides an__iter__
method to iterate through itstransfer_jobs
field.If there are more pages, the
__iter__
method will make additionalListTransferJobs
requests and continue to iterate through thetransfer_jobs
field on the corresponding responses.All the usual
google.cloud.storage_transfer_v1.types.ListTransferJobsResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.storage_transfer_v1.types.ListTransferJobsRequest) – The initial request object.
response (google.cloud.storage_transfer_v1.types.ListTransferJobsResponse) – The initial response object.
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.