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.

class BigQueryDataTransfer {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsDataSourcesCheckValidCreds(name: string, req: CheckValidCredsRequest): Promise<CheckValidCredsResponse>;

async projectsDataSourcesGet(name: string): Promise<DataSource>;

async projectsDataSourcesList(parent: string, opts?: ProjectsDataSourcesListOptions): Promise<ListDataSourcesResponse>;

async projectsEnrollDataSources(name: string, req: EnrollDataSourcesRequest): Promise<Empty>;

async projectsLocationsDataSourcesCheckValidCreds(name: string, req: CheckValidCredsRequest): Promise<CheckValidCredsResponse>;

async projectsLocationsDataSourcesGet(name: string): Promise<DataSource>;

async projectsLocationsDataSourcesList(parent: string, opts?: ProjectsLocationsDataSourcesListOptions): Promise<ListDataSourcesResponse>;

async projectsLocationsEnrollDataSources(name: string, req: EnrollDataSourcesRequest): Promise<Empty>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsTransferConfigsCreate(

parent: string,

req: TransferConfig,

opts?: ProjectsLocationsTransferConfigsCreateOptions,

): Promise<TransferConfig>;

async projectsLocationsTransferConfigsDelete(name: string): Promise<Empty>;

async projectsLocationsTransferConfigsGet(name: string): Promise<TransferConfig>;

async projectsLocationsTransferConfigsList(parent: string, opts?: ProjectsLocationsTransferConfigsListOptions): Promise<ListTransferConfigsResponse>;

async projectsLocationsTransferConfigsPatch(

name: string,

req: TransferConfig,

opts?: ProjectsLocationsTransferConfigsPatchOptions,

): Promise<TransferConfig>;

async projectsLocationsTransferConfigsRunsDelete(name: string): Promise<Empty>;

async projectsLocationsTransferConfigsRunsGet(name: string): Promise<TransferRun>;

async projectsLocationsTransferConfigsRunsList(parent: string, opts?: ProjectsLocationsTransferConfigsRunsListOptions): Promise<ListTransferRunsResponse>;

async projectsLocationsTransferConfigsRunsTransferLogsList(parent: string, opts?: ProjectsLocationsTransferConfigsRunsTransferLogsListOptions): Promise<ListTransferLogsResponse>;

async projectsLocationsTransferConfigsScheduleRuns(parent: string, req: ScheduleTransferRunsRequest): Promise<ScheduleTransferRunsResponse>;

async projectsLocationsTransferConfigsStartManualRuns(parent: string, req: StartManualTransferRunsRequest): Promise<StartManualTransferRunsResponse>;

async projectsLocationsUnenrollDataSources(name: string, req: UnenrollDataSourcesRequest): Promise<Empty>;

async projectsTransferConfigsCreate(

parent: string,

req: TransferConfig,

opts?: ProjectsTransferConfigsCreateOptions,

): Promise<TransferConfig>;

async projectsTransferConfigsDelete(name: string): Promise<Empty>;

async projectsTransferConfigsGet(name: string): Promise<TransferConfig>;

async projectsTransferConfigsList(parent: string, opts?: ProjectsTransferConfigsListOptions): Promise<ListTransferConfigsResponse>;

async projectsTransferConfigsPatch(

name: string,

req: TransferConfig,

opts?: ProjectsTransferConfigsPatchOptions,

): Promise<TransferConfig>;

async projectsTransferConfigsRunsDelete(name: string): Promise<Empty>;

async projectsTransferConfigsRunsGet(name: string): Promise<TransferRun>;

async projectsTransferConfigsRunsList(parent: string, opts?: ProjectsTransferConfigsRunsListOptions): Promise<ListTransferRunsResponse>;

async projectsTransferConfigsRunsTransferLogsList(parent: string, opts?: ProjectsTransferConfigsRunsTransferLogsListOptions): Promise<ListTransferLogsResponse>;

async projectsTransferConfigsScheduleRuns(parent: string, req: ScheduleTransferRunsRequest): Promise<ScheduleTransferRunsResponse>;

async projectsTransferConfigsStartManualRuns(parent: string, req: StartManualTransferRunsRequest): Promise<StartManualTransferRunsResponse>;

}

§Constructors

new BigQueryDataTransfer(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsDataSourcesCheckValidCreds(name: string, req: CheckValidCredsRequest): Promise<CheckValidCredsResponse>

[src]

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

@param name

Required. The name of the data source. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/dataSources/{data_source_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

projectsDataSourcesGet(name: string): Promise<DataSource>

[src]

Retrieves a supported data source and returns its settings.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/dataSources/{data_source_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

projectsDataSourcesList(parent: string, opts?: ProjectsDataSourcesListOptions): Promise<ListDataSourcesResponse>

[src]

Lists supported data sources and returns their settings.

@param parent

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}

projectsEnrollDataSources(name: string, req: EnrollDataSourcesRequest): Promise<Empty>

[src]

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.

@param name

Required. The name of the project resource in the form: projects/{project_id}

projectsLocationsDataSourcesCheckValidCreds(name: string, req: CheckValidCredsRequest): Promise<CheckValidCredsResponse>

[src]

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

@param name

projectsLocationsDataSourcesGet(name: string): Promise<DataSource>

[src]

Retrieves a supported data source and returns its settings.

@param name

projectsLocationsDataSourcesList(parent: string, opts?: ProjectsLocationsDataSourcesListOptions): Promise<ListDataSourcesResponse>

[src]

Lists supported data sources and returns their settings.

@param parent

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}

projectsLocationsEnrollDataSources(name: string, req: EnrollDataSourcesRequest): Promise<Empty>

[src]

@param name

Required. The name of the project resource in the form: projects/{project_id}

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsTransferConfigsCreate(parent: string, req: TransferConfig, opts?: ProjectsLocationsTransferConfigsCreateOptions): Promise<TransferConfig>

[src]

Creates a new data transfer configuration.

@param parent

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.

projectsLocationsTransferConfigsDelete(name: string): Promise<Empty>

[src]

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

@param name

Required. The name of the resource to delete. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

projectsLocationsTransferConfigsGet(name: string): Promise<TransferConfig>

[src]

Returns information about a data transfer config.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

projectsLocationsTransferConfigsList(parent: string, opts?: ProjectsLocationsTransferConfigsListOptions): Promise<ListTransferConfigsResponse>

[src]

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

@param parent

Required. The BigQuery project id for which transfer configs should be returned. If you are using the regionless method, the location must be US and parent should be in the following form: * projects/{project_id} If you are using the regionalized method, parentshould be in the following form: *projects/{project_id}/locations/{location_id}`

projectsLocationsTransferConfigsPatch(name: string, req: TransferConfig, opts?: ProjectsLocationsTransferConfigsPatchOptions): Promise<TransferConfig>

[src]

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

@param name

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.

projectsLocationsTransferConfigsRunsDelete(name: string): Promise<Empty>

[src]

Deletes the specified transfer run.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

projectsLocationsTransferConfigsRunsGet(name: string): Promise<TransferRun>

[src]

Returns information about the particular transfer run.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

projectsLocationsTransferConfigsRunsList(parent: string, opts?: ProjectsLocationsTransferConfigsRunsListOptions): Promise<ListTransferRunsResponse>

[src]

Returns information about running and completed transfer runs.

@param parent

Required. Name of transfer configuration for which transfer runs should be retrieved. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

projectsLocationsTransferConfigsRunsTransferLogsList(parent: string, opts?: ProjectsLocationsTransferConfigsRunsTransferLogsListOptions): Promise<ListTransferLogsResponse>

[src]

Returns log messages for the transfer run.

@param parent

Required. Transfer run name. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

projectsLocationsTransferConfigsScheduleRuns(parent: string, req: ScheduleTransferRunsRequest): Promise<ScheduleTransferRunsResponse>

[src]

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.

@param parent

Required. Transfer configuration name. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

projectsLocationsTransferConfigsStartManualRuns(parent: string, req: StartManualTransferRunsRequest): Promise<StartManualTransferRunsResponse>

[src]

Manually initiates transfer runs. You can schedule these runs in two ways:

For a specific point in time using the 'requested_run_time' parameter.
For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.

@param parent

projectsLocationsUnenrollDataSources(name: string, req: UnenrollDataSourcesRequest): Promise<Empty>

[src]

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.

@param name

Required. The name of the project resource in the form: projects/{project_id}

projectsTransferConfigsCreate(parent: string, req: TransferConfig, opts?: ProjectsTransferConfigsCreateOptions): Promise<TransferConfig>

[src]

Creates a new data transfer configuration.

@param parent

projectsTransferConfigsDelete(name: string): Promise<Empty>

[src]

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

@param name

projectsTransferConfigsGet(name: string): Promise<TransferConfig>

[src]

Returns information about a data transfer config.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

projectsTransferConfigsList(parent: string, opts?: ProjectsTransferConfigsListOptions): Promise<ListTransferConfigsResponse>

[src]

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

@param parent

projectsTransferConfigsPatch(name: string, req: TransferConfig, opts?: ProjectsTransferConfigsPatchOptions): Promise<TransferConfig>

[src]

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

@param name

projectsTransferConfigsRunsDelete(name: string): Promise<Empty>

[src]

Deletes the specified transfer run.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

projectsTransferConfigsRunsGet(name: string): Promise<TransferRun>

[src]

Returns information about the particular transfer run.

@param name

Required. The name of the resource requested. If you are using the regionless method, the location must be US and the name should be in the following form: * projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} If you are using the regionalized method, the name should be in the following form: * projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

projectsTransferConfigsRunsList(parent: string, opts?: ProjectsTransferConfigsRunsListOptions): Promise<ListTransferRunsResponse>

[src]

Returns information about running and completed transfer runs.

@param parent

projectsTransferConfigsRunsTransferLogsList(parent: string, opts?: ProjectsTransferConfigsRunsTransferLogsListOptions): Promise<ListTransferLogsResponse>

[src]

Returns log messages for the transfer run.

@param parent

projectsTransferConfigsScheduleRuns(parent: string, req: ScheduleTransferRunsRequest): Promise<ScheduleTransferRunsResponse>

[src]

@param parent

projectsTransferConfigsStartManualRuns(parent: string, req: StartManualTransferRunsRequest): Promise<StartManualTransferRunsResponse>

[src]

Manually initiates transfer runs. You can schedule these runs in two ways:

For a specific point in time using the 'requested_run_time' parameter.
For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is set to execute immediately (schedule_time equals the current time). When scheduling multiple runs within a time range, the first run starts now, and subsequent runs are delayed by 15 seconds each.

@param parent