BigQueryDataTransfer
import { BigQueryDataTransfer } from "https://googleapis.deno.dev/v1/bigquerydatatransfer:v1.ts";
Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.
§Methods
Returns true if valid credentials exist for the given data source and requesting user.
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}
.
Retrieves a supported data source and returns its settings.
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}
Lists supported data sources and returns their settings.
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}
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, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Required. The name of the project resource in the form: projects/{project_id}
Returns true if valid credentials exist for the given data source and requesting user.
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}
.
Retrieves a supported data source and returns its settings.
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}
Lists supported data sources and returns their settings.
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}
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, and the documents can be found in the public guide for BigQuery Web UI and Data Transfer Service.
Required. The name of the project resource in the form: projects/{project_id}
Lists information about the supported locations for this service.
The resource that owns the locations collection, if applicable.
Creates a new data transfer configuration.
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.
Deletes a data transfer configuration, including any associated transfer runs and logs.
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}
Returns information about a data transfer config.
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}
Returns information about all transfer configs owned by a project in the specified location.
Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id}
or projects/{project_id}/locations/{location_id}
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id}
or projects/{project_id}/transferConfigs/{config_id}
, where config_id
is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Deletes the specified transfer run.
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}
Returns information about the particular transfer run.
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}
Returns information about running and completed transfer runs.
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}
.
Returns log messages for the transfer run.
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}
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.
Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}
or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
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.
Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}
or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
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. Data transfers configurations of unenrolled data sources will not be scheduled.
Required. The name of the project resource in the form: projects/{project_id}
Creates a new data transfer configuration.
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.
Deletes a data transfer configuration, including any associated transfer runs and logs.
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}
Returns information about a data transfer config.
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}
Returns information about all transfer configs owned by a project in the specified location.
Required. The BigQuery project id for which transfer configs should be returned: projects/{project_id}
or projects/{project_id}/locations/{location_id}
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id}
or projects/{project_id}/transferConfigs/{config_id}
, where config_id
is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.
Deletes the specified transfer run.
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}
Returns information about the particular transfer run.
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}
Returns information about running and completed transfer runs.
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}
.
Returns log messages for the transfer run.
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}
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.
Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}
or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.
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.
Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id}
or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}
.