As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

DataTransferService

class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.DataTransferServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Instantiates the data 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 (Union[str, DataTransferServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

async check_valid_creds(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsResponse[source]

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn’t support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest) – 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.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

A response indicating whether the credentials exist and are valid.

Return type

google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsResponse

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder 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.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async create_transfer_config(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.CreateTransferConfigRequest] = None, *, parent: Optional[str] = None, transfer_config: Optional[google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

Creates a new data transfer configuration.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest) – The request object. A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. 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 (google.cloud.bigquery_datatransfer_v1.types.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.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 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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

static data_source_path(project: str, data_source: str)str

Returns a fully-qualified data_source string.

async delete_transfer_config(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a data transfer configuration, including any associated transfer runs and logs.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest) – 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.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.

async delete_transfer_run(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified transfer run.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest) – 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.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

DataTransferServiceAsyncClient

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

DataTransferServiceAsyncClient

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

DataTransferServiceAsyncClient

async get_data_source(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetDataSourceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.DataSource[source]

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.GetDataSourceRequest) – 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.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 data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

Return type

google.cloud.bigquery_datatransfer_v1.types.DataSource

async get_transfer_config(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferConfigRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

Returns information about a data transfer config.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.GetTransferConfigRequest) – 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.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 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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

async get_transfer_run(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferRunRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferRun[source]

Returns information about the particular transfer run.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.GetTransferRunRequest) – 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.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 a data transfer run.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferRun

get_transport_class()Type[google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport]

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_data_sources(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesAsyncPager[source]

Lists supported data sources and returns their settings, which can be used for UI rendering.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest) – 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.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

Returns list of supported data sources and their metadata. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesAsyncPager

async list_transfer_configs(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsAsyncPager[source]

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

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest) – The request object. A request to list data transfers configured for a BigQuery project.

  • parent (str) –

    Required. The BigQuery project id for which data sources 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.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

The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsAsyncPager

async list_transfer_logs(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsAsyncPager[source]

Returns user facing log messages for the data transfer run.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest) – 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.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

The returned list transfer run messages. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsAsyncPager

async list_transfer_runs(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsAsyncPager[source]

Returns information about running and completed jobs.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest) – The request object. A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled 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.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

The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsAsyncPager

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.

static parse_data_source_path(path: str)Dict[str, str]

Parses a data_source path into its component segments.

static parse_run_path(path: str)Dict[str, str]

Parses a run path into its component segments.

static parse_transfer_config_path(path: str)Dict[str, str]

Parses a transfer_config path into its component segments.

static run_path(project: str, transfer_config: str, run: str)str

Returns a fully-qualified run string.

async schedule_transfer_runs(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsRequest] = None, *, parent: Optional[str] = None, start_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, end_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsResponse[source]

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.

Parameters
  • request (google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsRequest) – 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.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

A response to schedule transfer runs for a time range.

Return type

google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsResponse

async start_manual_transfer_runs(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsResponse[source]

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.

Parameters
Returns

A response to start manual transfer runs.

Return type

google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsResponse

static transfer_config_path(project: str, transfer_config: str)str

Returns a fully-qualified transfer_config string.

property transport: google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

DataTransferServiceTransport

async update_transfer_config(request: Optional[google.cloud.bigquery_datatransfer_v1.types.datatransfer.UpdateTransferConfigRequest] = None, *, transfer_config: Optional[google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

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

Parameters
Returns

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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

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

The Google BigQuery Data Transfer Service API enables BigQuery users to configure the transfer of their data from other Google Products into BigQuery. This service contains methods that are end user exposed. It backs up the frontend.

Instantiates the data 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 (Union[str, DataTransferServiceTransport]) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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!

check_valid_creds(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.CheckValidCredsResponse[source]

Returns true if valid credentials exist for the given data source and requesting user. Some data sources doesn’t support service account, so we need to talk to them on behalf of the end user. This API just checks whether we have OAuth token for the particular user, which is a pre-requisite before user can create a transfer config.

Parameters
  • request (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.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

A response indicating whether the credentials exist and are valid.

Return type

google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsResponse

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder 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.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

create_transfer_config(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.CreateTransferConfigRequest, dict]] = None, *, parent: Optional[str] = None, transfer_config: Optional[google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

Creates a new data transfer configuration.

Parameters
  • request (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, an authorization code must be provided. If an authorization code is provided, the transfer configuration will be associated with the user id corresponding to the authorization code. 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 (google.cloud.bigquery_datatransfer_v1.types.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.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 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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

static data_source_path(project: str, data_source: str)str[source]

Returns a fully-qualified data_source string.

delete_transfer_config(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes a data transfer configuration, including any associated transfer runs and logs.

Parameters
  • request (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.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_run(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.DeleteTransferRunRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())None[source]

Deletes the specified transfer run.

Parameters
  • request (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.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

DataTransferServiceClient

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

DataTransferServiceClient

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

DataTransferServiceClient

get_data_source(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetDataSourceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.DataSource[source]

Retrieves a supported data source and returns its settings, which can be used for UI rendering.

Parameters
  • request (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.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 data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

Return type

google.cloud.bigquery_datatransfer_v1.types.DataSource

get_transfer_config(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferConfigRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

Returns information about a data transfer config.

Parameters
  • request (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.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 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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

get_transfer_run(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.GetTransferRunRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferRun[source]

Returns information about the particular transfer run.

Parameters
  • request (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.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 a data transfer run.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferRun

list_data_sources(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesPager[source]

Lists supported data sources and returns their settings, which can be used for UI rendering.

Parameters
  • request (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.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

Returns list of supported data sources and their metadata. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesPager

list_transfer_configs(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsPager[source]

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

Parameters
  • request (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 data sources 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.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

The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsPager

list_transfer_logs(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsPager[source]

Returns user facing log messages for the data transfer run.

Parameters
  • request (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.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

The returned list transfer run messages. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsPager

list_transfer_runs(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsPager[source]

Returns information about running and completed jobs.

Parameters
  • request (Union[google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest, dict]) – The request object. A request to list data transfer runs. UI can use this method to show/filter specific data transfer runs. The data source can use this method to request all scheduled 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.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

The returned list of pipelines in the project. Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsPager

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.

static parse_data_source_path(path: str)Dict[str, str][source]

Parses a data_source path into its component segments.

static parse_run_path(path: str)Dict[str, str][source]

Parses a run path into its component segments.

static parse_transfer_config_path(path: str)Dict[str, str][source]

Parses a transfer_config path into its component segments.

static run_path(project: str, transfer_config: str, run: str)str[source]

Returns a fully-qualified run string.

schedule_transfer_runs(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsRequest, dict]] = None, *, parent: Optional[str] = None, start_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, end_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.ScheduleTransferRunsResponse[source]

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.

Parameters
  • request (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.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

A response to schedule transfer runs for a time range.

Return type

google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsResponse

start_manual_transfer_runs(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.datatransfer.StartManualTransferRunsResponse[source]

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.

Parameters
Returns

A response to start manual transfer runs.

Return type

google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsResponse

static transfer_config_path(project: str, transfer_config: str)str[source]

Returns a fully-qualified transfer_config string.

property transport: google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.transports.base.DataTransferServiceTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

DataTransferServiceTransport

update_transfer_config(request: Optional[Union[google.cloud.bigquery_datatransfer_v1.types.datatransfer.UpdateTransferConfigRequest, dict]] = None, *, transfer_config: Optional[google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.bigquery_datatransfer_v1.types.transfer.TransferConfig[source]

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

Parameters
Returns

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.

Return type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesAsyncPager(method: Callable[[...], Awaitable[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesResponse]], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_data_sources requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse object, and provides an __aiter__ method to iterate through its data_sources field.

If there are more pages, the __aiter__ method will make additional ListDataSources requests and continue to iterate through the data_sources field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListDataSourcesPager(method: Callable[[...], google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesResponse], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListDataSourcesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_data_sources requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse object, and provides an __iter__ method to iterate through its data_sources field.

If there are more pages, the __iter__ method will make additional ListDataSources requests and continue to iterate through the data_sources field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsAsyncPager(method: Callable[[...], Awaitable[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse]], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_configs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse object, and provides an __aiter__ method to iterate through its transfer_configs field.

If there are more pages, the __aiter__ method will make additional ListTransferConfigs requests and continue to iterate through the transfer_configs field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferConfigsPager(method: Callable[[...], google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferConfigsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_configs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse object, and provides an __iter__ method to iterate through its transfer_configs field.

If there are more pages, the __iter__ method will make additional ListTransferConfigs requests and continue to iterate through the transfer_configs field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsAsyncPager(method: Callable[[...], Awaitable[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsResponse]], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_logs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsResponse object, and provides an __aiter__ method to iterate through its transfer_messages field.

If there are more pages, the __aiter__ method will make additional ListTransferLogs requests and continue to iterate through the transfer_messages field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferLogsPager(method: Callable[[...], google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsResponse], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferLogsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_logs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsResponse object, and provides an __iter__ method to iterate through its transfer_messages field.

If there are more pages, the __iter__ method will make additional ListTransferLogs requests and continue to iterate through the transfer_messages field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsAsyncPager(method: Callable[[...], Awaitable[google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsResponse]], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_runs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse object, and provides an __aiter__ method to iterate through its transfer_runs field.

If there are more pages, the __aiter__ method will make additional ListTransferRuns requests and continue to iterate through the transfer_runs field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse 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
class google.cloud.bigquery_datatransfer_v1.services.data_transfer_service.pagers.ListTransferRunsPager(method: Callable[[...], google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsResponse], request: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsRequest, response: google.cloud.bigquery_datatransfer_v1.types.datatransfer.ListTransferRunsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_transfer_runs requests.

This class thinly wraps an initial google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse object, and provides an __iter__ method to iterate through its transfer_runs field.

If there are more pages, the __iter__ method will make additional ListTransferRuns requests and continue to iterate through the transfer_runs field on the corresponding responses.

All the usual google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse 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