Class DataTransferServiceAsyncClient (3.15.6) 

DataTransferServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport, typing.Callable[[...], google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport]]] = '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>)

This API allows users to manage their data transfers into BigQuery.

Properties

api_endpoint

Return the API endpoint used by the client instance.

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

transport

Returns the transport used by the client instance.

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

universe_domain

Return the universe domain used by the client instance.

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

Methods

DataTransferServiceAsyncClient

DataTransferServiceAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport, typing.Callable[[...], google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the data transfer service async client.

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

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport Optional[Union[str,DataTransferServiceTransport,Callable[..., DataTransferServiceTransport]]]

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 DataTransferServiceTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

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

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

check_valid_creds

check_valid_creds(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsRequest,
            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.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsResponse

Returns true if valid credentials exist for the given data source and requesting user.

# 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 bigquery_datatransfer_v1

async def sample_check_valid_creds():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.CheckValidCredsRequest(
        name="name_value",
    )

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

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

The request object. A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
name str

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}. This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsResponse A response indicating whether the credentials exist and are valid.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

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

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_transfer_config

create_transfer_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.CreateTransferConfigRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    transfer_config: typing.Optional[
        google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig
    ] = 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.bigquery_datatransfer_v1.types.transfer.TransferConfig

Creates a new data transfer configuration.

# 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 bigquery_datatransfer_v1

async def sample_create_transfer_config():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    transfer_config = bigquery_datatransfer_v1.TransferConfig()
    transfer_config.destination_dataset_id = "destination_dataset_id_value"

    request = bigquery_datatransfer_v1.CreateTransferConfigRequest(
        parent="parent_value",
        transfer_config=transfer_config,
    )

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

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

The request object. A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.
parent str

Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
transfer_config TransferConfig

Required. Data transfer configuration to create. This corresponds to the transfer_config field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.TransferConfig Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

data_source_path

data_source_path(project: str, data_source: str) -> str

Returns a fully-qualified data_source string.

delete_transfer_config

delete_transfer_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferConfigRequest,
            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 a data transfer configuration, including any associated transfer runs and logs.

# 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 bigquery_datatransfer_v1

async def sample_delete_transfer_config():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.DeleteTransferConfigRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_transfer_config(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest, dict]]

The request object. A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
name str

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

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

delete_transfer_run

delete_transfer_run(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferRunRequest,
            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 the specified transfer run.

# 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 bigquery_datatransfer_v1

async def sample_delete_transfer_run():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.DeleteTransferRunRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_transfer_run(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest, dict]]

The request object. A request to delete data transfer run information.
name str

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

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

enroll_data_sources

enroll_data_sources(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.EnrollDataSourcesRequest,
            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

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the BigQuery UI <https://console.cloud.google.com/bigquery>, and the documents can be found in the public guide for BigQuery Web UI <https://cloud.google.com/bigquery/bigquery-web-ui> and Data Transfer Service <https://cloud.google.com/bigquery/docs/working-with-transfers>__.

# 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 bigquery_datatransfer_v1

async def sample_enroll_data_sources():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.EnrollDataSourcesRequest(
        name="name_value",
    )

    # Make the request
    await client.enroll_data_sources(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest, dict]]

The request object. A request to enroll a set of data sources so they are visible in the BigQuery UI's Transfer tab.
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.

from_service_account_file

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
DataTransferServiceAsyncClient The constructed client.

from_service_account_info

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

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

Parameter
Name Description
info dict

The service account private key info.
Returns
Type Description
DataTransferServiceAsyncClient The constructed client.

from_service_account_json

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

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

Parameter
Name Description
filename str

The path to the service account private key json file.
Returns
Type Description
DataTransferServiceAsyncClient The constructed client.

get_data_source

get_data_source(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetDataSourceRequest,
            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.bigquery_datatransfer_v1.types.datatransfer.DataSource

Retrieves a supported data source and returns its settings.

# 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 bigquery_datatransfer_v1

async def sample_get_data_source():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.GetDataSourceRequest(
        name="name_value",
    )

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

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

The request object. A request to get data source info.
name str

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.DataSource Defines the properties and custom parameters for a data source.

get_location

get_location(
    request: typing.Optional[
        google.cloud.location.locations_pb2.GetLocationRequest
    ] = 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.location.locations_pb2.Location

Gets information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation 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
Type Description
.location_pb2.Location Location object.

get_mtls_endpoint_and_cert_source

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

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

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

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

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

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_transfer_config

get_transfer_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferConfigRequest,
            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.bigquery_datatransfer_v1.types.transfer.TransferConfig

Returns information about a data transfer config.

# 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 bigquery_datatransfer_v1

async def sample_get_transfer_config():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.GetTransferConfigRequest(
        name="name_value",
    )

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

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

The request object. A request to get data transfer information.
name str

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.TransferConfig Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

get_transfer_run

get_transfer_run(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferRunRequest,
            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.bigquery_datatransfer_v1.types.transfer.TransferRun

Returns information about the particular transfer run.

# 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 bigquery_datatransfer_v1

async def sample_get_transfer_run():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.GetTransferRunRequest(
        name="name_value",
    )

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

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

The request object. A request to get data transfer run information.
name str

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} This corresponds to the name field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.TransferRun Represents a data transfer run.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport
]

Returns an appropriate transport class.

Parameter
Name Description
label typing.Optional[str]

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

list_data_sources

list_data_sources(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesAsyncPager
)

Lists supported data sources and returns their settings.

# 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 bigquery_datatransfer_v1

async def sample_list_data_sources():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.ListDataSourcesRequest(
        parent="parent_value",
    )

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

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

The request object. Request to list supported data sources and their data transfer settings.
parent str

Required. The BigQuery project id for which data sources should be returned. Must be in the form: projects/{project_id} or projects/{project_id}/locations/{location_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesAsyncPager Returns list of supported data sources and their metadata. Iterating over this object will yield results and resolve additional pages automatically.

list_locations

list_locations(
    request: typing.Optional[
        google.cloud.location.locations_pb2.ListLocationsRequest
    ] = 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.location.locations_pb2.ListLocationsResponse

Lists information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations 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
Type Description
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_transfer_configs

list_transfer_configs(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsAsyncPager
)

Returns information about all transfer configs owned by a project in the specified location.

# 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 bigquery_datatransfer_v1

async def sample_list_transfer_configs():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.ListTransferConfigsRequest(
        parent="parent_value",
    )

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

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

The request object. A request to list data transfers configured for a BigQuery project.
parent str

Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsAsyncPager The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

list_transfer_logs

list_transfer_logs(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsAsyncPager
)

Returns log messages for the transfer run.

# 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 bigquery_datatransfer_v1

async def sample_list_transfer_logs():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.ListTransferLogsRequest(
        parent="parent_value",
    )

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

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

The request object. A request to get user facing log messages associated with data transfer run.
parent str

Required. Transfer run name in the form: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id} This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsAsyncPager The returned list transfer run messages. Iterating over this object will yield results and resolve additional pages automatically.

list_transfer_runs

list_transfer_runs(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
    google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsAsyncPager
)

Returns information about running and completed transfer runs.

# 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 bigquery_datatransfer_v1

async def sample_list_transfer_runs():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.ListTransferRunsRequest(
        parent="parent_value",
    )

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

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

The request object. A request to list data transfer runs.
parent str

Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsAsyncPager The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

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

Parse a billing_account path into its component segments.

parse_common_folder_path

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

Parse a folder path into its component segments.

parse_common_location_path

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

Parse a location path into its component segments.

parse_common_organization_path

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

Parse a organization path into its component segments.

parse_common_project_path

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

Parse a project path into its component segments.

parse_data_source_path

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

Parses a data_source path into its component segments.

parse_run_path

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

Parses a run path into its component segments.

parse_transfer_config_path

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

Parses a transfer_config path into its component segments.

run_path

run_path(project: str, transfer_config: str, run: str) -> str

Returns a fully-qualified run string.

schedule_transfer_runs

schedule_transfer_runs(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    start_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = None,
    end_time: typing.Optional[google.protobuf.timestamp_pb2.Timestamp] = 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.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsResponse
)

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports

  • in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead.
# 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 bigquery_datatransfer_v1

async def sample_schedule_transfer_runs():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.ScheduleTransferRunsRequest(
        parent="parent_value",
    )

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

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

The request object. A request to schedule transfer runs for a time range.
parent str

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}. This corresponds to the parent field on the request instance; if request is provided, this should not be set.
start_time google.protobuf.timestamp_pb2.Timestamp

Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00". This corresponds to the start_time field on the request instance; if request is provided, this should not be set.
end_time google.protobuf.timestamp_pb2.Timestamp

Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00". This corresponds to the end_time field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsResponse A response to schedule transfer runs for a time range.

start_manual_transfer_runs

start_manual_transfer_runs(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsRequest,
            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.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsResponse
)

Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time.

# 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 bigquery_datatransfer_v1

async def sample_start_manual_transfer_runs():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.StartManualTransferRunsRequest(
        parent="parent_value",
    )

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

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

The request object. A request to start manual transfer runs.
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
Type Description
google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsResponse A response to start manual transfer runs.

transfer_config_path

transfer_config_path(project: str, transfer_config: str) -> str

Returns a fully-qualified transfer_config string.

unenroll_data_sources

unenroll_data_sources(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.UnenrollDataSourcesRequest,
            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

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the BigQuery UI <https://console.cloud.google.com/bigquery>__. Data transfers configurations of unenrolled data sources will not be scheduled.

# 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 bigquery_datatransfer_v1

async def sample_unenroll_data_sources():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    request = bigquery_datatransfer_v1.UnenrollDataSourcesRequest(
        name="name_value",
    )

    # Make the request
    await client.unenroll_data_sources(request=request)
Parameters
Name Description
request Optional[Union[google.cloud.bigquery_datatransfer_v1.types.UnenrollDataSourcesRequest, dict]]

The request object. A request to unenroll a set of data sources so they are no longer visible in the BigQuery UI's Transfer tab.
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.

update_transfer_config

update_transfer_config(
    request: typing.Optional[
        typing.Union[
            google.cloud.bigquery_datatransfer_v1.types.datatransfer.UpdateTransferConfigRequest,
            dict,
        ]
    ] = None,
    *,
    transfer_config: typing.Optional[
        google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig
    ] = 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.bigquery_datatransfer_v1.types.transfer.TransferConfig

Updates a data transfer configuration. All fields must be set, even if they are not updated.

# 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 bigquery_datatransfer_v1

async def sample_update_transfer_config():
    # Create a client
    client = bigquery_datatransfer_v1.DataTransferServiceAsyncClient()

    # Initialize request argument(s)
    transfer_config = bigquery_datatransfer_v1.TransferConfig()
    transfer_config.destination_dataset_id = "destination_dataset_id_value"

    request = bigquery_datatransfer_v1.UpdateTransferConfigRequest(
        transfer_config=transfer_config,
    )

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

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

The request object. A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
transfer_config TransferConfig

Required. Data transfer configuration to create. This corresponds to the transfer_config field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Required. Required list of fields to be updated in this request. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
retry google.api_core.retry_async.AsyncRetry

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

The timeout for this request.
metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.
Returns
Type Description
google.cloud.bigquery_datatransfer_v1.types.TransferConfig Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.