Package types (3.3.4)

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.

A response indicating whether the credentials exist and are valid.

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.

Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

Represents a data source parameter with validation rules, so that parameters can be rendered in the UI. These parameters are given to us by supported data sources, and include all needed information for rendering and validation. Thus, whoever uses this api can decide to generate either generic ui, or custom data source specific forms.

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

A request to delete data transfer run information. .. attribute:: name

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}

:type: str

Represents preferences for sending email notifications for transfer run events.

A request to get data source info. .. attribute:: name

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}

:type: str

A request to get data transfer information. .. attribute:: name

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}

:type: str

A request to get data transfer run information. .. attribute:: name

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}

:type: str

Request to list supported data sources and their data transfer settings.

Returns list of supported data sources and their metadata. .. attribute:: data_sources

List of supported data sources and their transfer settings.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.DataSource]

A request to list data transfers configured for a BigQuery project.

The returned list of pipelines in the project. .. attribute:: transfer_configs

Output only. The stored pipeline transfer configurations.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferConfig]

A request to get user facing log messages associated with data transfer run.

The returned list transfer run messages. .. attribute:: transfer_messages

Output only. The stored pipeline transfer messages.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferMessage]

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.

The returned list of pipelines in the project. .. attribute:: transfer_runs

Output only. The stored pipeline transfer runs.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]

Options customizing the data transfer schedule. .. attribute:: disable_auto_scheduling

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

:type: bool

A request to schedule transfer runs for a time range. .. attribute:: parent

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

:type: str

A response to schedule transfer runs for a time range. .. attribute:: runs

The transfer runs that were scheduled.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]

A request to start manual transfer runs. .. attribute:: parent

Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

:type: str

A response to start manual transfer runs. .. attribute:: runs

The transfer runs that were created.

:type: Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]

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.

Represents a user facing message for a particular data transfer run.

Represents a data transfer run. .. attribute:: name

The resource name of the transfer run. Transfer run names have the form projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.

:type: str

Represents data transfer run state.

DEPRECATED. Represents data transfer type.

A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.