Ballerina library

googleapis.bigquery.datatransfer

Module googleapis.bigquery.datatransfer

OverviewPrerequisitesQuickstart

API

Client

Definitions

CheckValidCredsRequest
CheckValidCredsResponse
ClientHttp1Settings
ConnectionConfig
DataSource
DataSourceParameter
EmailPreferences
ListDataSourcesResponse
ListLocationsResponse
ListTransferConfigsResponse
ListTransferLogsResponse
ListTransferRunsResponse
Location
OAuth2RefreshTokenGrantConfig
ProxyConfig
ScheduleOptions
ScheduleTransferRunsRequest
ScheduleTransferRunsResponse
StartManualTransferRunsRequest
StartManualTransferRunsResponse
Status
TimeRange
TransferConfig
TransferMessage
TransferRun

ballerinax/googleapis.bigquery.datatransfer Ballerina library

1.5.2

Overview

The Google BigQuery Data Transfer API v1 connector(https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest) OpenAPI specification. The BigQuery Data Transfer API provides access schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis..

Key Features

  • Programmatic access to create and manage resources via REST API
  • Manage user accounts and profiles
  • Secure authentication with API key or OAuth support

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Google BigQuery connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/googleapis.bigquery.datatransfer module into the Ballerina project.

Copy
import ballerinax/googleapis.bigquery.datatransfer;

Step 2: Create a new connector instance

Create a datatransfer:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.

Copy
datatransfer:ClientConfig clientConfig = {auth : {token: "<Your access token>"}};
datatransfer:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

  1. Now you can invoke the connector operations as follows,

    List projects

    Copy
    public function main() returns error? {
    datatransfer:TransferRun runInfo = check baseClient->getTransferRun(name);
}

  2. Use bal run command to compile and run the Ballerina program.

Clients

googleapis.bigquery.datatransfer: Client

Isolated

This is a generated connector for Google BigQuery Data Transfer API v2.0 OpenAPI specification. The BigQuery Data Transfer API schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an google account and obtain tokens following this guide

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string "https://bigquerydatatransfer.googleapis.com/" - URL of the target service

getTransferRun

Isolated FunctionRemote Function
function getTransferRun(string name, string? xgafv, string? alt, string? callback, string? quotaUser, string? uploadProtocol, string? uploadType) returns TransferRun|error

Returns information about the particular transfer run.

Parameters
  • name string - 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}
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

deleteTransferRun

Isolated FunctionRemote Function
function deleteTransferRun(string name, string? xgafv, string? alt, string? callback, string? quotaUser, string? uploadProtocol, string? uploadType) returns Response|error

Deletes the specified transfer run.

Parameters
  • name string - 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}
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

updateTransferRun

Isolated FunctionRemote Function
function updateTransferRun(string name, TransferConfig payload, string? xgafv, string? alt, string? callback, string? quotaUser, string? uploadProtocol, string? uploadType, string? authorizationCode, string? serviceAccountName, string? updateMask, string? versionInfo) returns TransferConfig|error

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

Parameters
  • name string - The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • authorizationCode string? (default ()) - Optional OAuth2 authorization code to use with this transfer configuration. If it is provided, the transfer configuration will be associated with the authorizing user. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
  • serviceAccountName string? (default ()) - Optional service account name. If this field is set and "service_account_name" is set in update_mask, transfer config will be updated to use this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
  • updateMask string? (default ()) - Required. Required list of fields to be updated in this request.
  • versionInfo string? (default ()) - Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Return Type

listProjectLocations

Isolated FunctionRemote Function
function listProjectLocations(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, int? pageSize, string? pageToken) returns ListLocationsResponse|error

Lists information about the supported locations for this service.

Parameters
  • name string - The resource that owns the locations collection, if applicable.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • filter string? (default ()) - A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
  • pageSize int? (default ()) - The maximum number of results to return. If not set, the service selects a default.
  • pageToken string? (default ()) - A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
Return Type

checkValidCreds

Isolated FunctionRemote Function
function checkValidCreds(string name, CheckValidCredsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CheckValidCredsResponse|error

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
  • name string - 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}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

listDataSources

Isolated FunctionRemote Function
function listDataSources(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListDataSourcesResponse|error

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

Parameters
  • parent string - 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} MISSING[]
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Page size. The default page size is the maximum value of 1000 results.
  • pageToken string? (default ()) - Pagination token, which can be used to request a specific page of ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.
Return Type

listJobs

Isolated FunctionRemote Function
function listJobs(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken, string? runAttempt, string[]? states) returns ListTransferRunsResponse|error

Returns information about running and completed jobs.

Parameters
  • parent string - 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}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • pageSize int? (default ()) - Page size. The default page size is the maximum value of 1000 results.
  • pageToken string? (default ()) - Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.
  • runAttempt string? (default ()) - Indicates how run attempts are to be pulled.
  • states string[]? (default ()) - When specified, only transfer runs with requested states are returned.
Return Type

listTransferConfigs

Isolated FunctionRemote Function
function listTransferConfigs(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? dataSourceIds, int? pageSize, string? pageToken) returns ListTransferConfigsResponse|error

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

Parameters
  • parent string - Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • dataSourceIds string[]? (default ()) - When specified, only configurations of requested data sources are returned.
  • pageSize int? (default ()) - Page size. The default page size is the maximum value of 1000 results.
  • pageToken string? (default ()) - Pagination token, which can be used to request a specific page of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.
Return Type

createTransferConfigs

Isolated FunctionRemote Function
function createTransferConfigs(string parent, TransferConfig payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? authorizationCode, string? serviceAccountName, string? versionInfo) returns TransferConfig|error

Creates a new data transfer configuration.

Parameters
  • parent string - 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.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • authorizationCode string? (default ()) - Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&redirect_uri= * client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. * redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.
  • serviceAccountName string? (default ()) - Optional service account name. If this field is set, transfer config will be created with this service account credentials. It requires that requesting user calling this API has permissions to act as this service account.
  • versionInfo string? (default ()) - Optional version info. If users want to find a very recent access token, that is, immediately after approving access, users have to set the version_info claim in the token request. To obtain the version_info, users must use the "none+gsession" response type. which be return a version_info back in the authorization response which be be put in a JWT claim in the token request.
Return Type

getTransferLogs

Isolated FunctionRemote Function
function getTransferLogs(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string[]? messageTypes, int? pageSize, string? pageToken) returns ListTransferLogsResponse|error

Returns user facing log messages for the data transfer run.

Parameters
  • parent string - 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}
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
  • messageTypes string[]? (default ()) - Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
  • pageSize int? (default ()) - Page size. The default page size is the maximum value of 1000 results.
  • pageToken string? (default ()) - Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.
Return Type

createScheduleRun

Isolated FunctionRemote Function
function createScheduleRun(string parent, ScheduleTransferRunsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns ScheduleTransferRunsResponse|error

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
  • parent string - Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

startManualRuns

Isolated FunctionRemote Function
function startManualRuns(string parent, StartManualTransferRunsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns StartManualTransferRunsResponse|error

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
  • parent string - Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.
  • xgafv string? (default ()) - V1 error format.
  • alt string? (default ()) - Data format for response.
  • callback string? (default ()) - JSONP
  • fields string? (default ()) - Selector specifying which fields to include in a partial response.
  • quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
  • uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
  • uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type

Records

googleapis.bigquery.datatransfer: CheckValidCredsRequest

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.

googleapis.bigquery.datatransfer: CheckValidCredsResponse

A response indicating whether the credentials exist and are valid.

Fields
  • hasValidCreds? boolean - If set to true, the credentials exist and are valid.

googleapis.bigquery.datatransfer: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

googleapis.bigquery.datatransfer: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache? CacheConfig - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig? RetryConfig - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.bigquery.datatransfer: DataSource

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

Fields
  • authorizationType? string - Indicates the type of authorization.
  • clientId? string - Data source client id which should be used to receive refresh token.
  • dataRefreshType? string - Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically.
  • dataSourceId? string - Data source id.
  • defaultDataRefreshWindowDays? int - Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.
  • defaultSchedule? string - Default data transfer schedule. Examples of valid schedules include: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00.
  • description? string - User friendly data source description string.
  • displayName? string - User friendly data source name.
  • helpUrl? string - Url for the help document for this data source.
  • manualRunsDisabled? boolean - Disables backfilling and manual run scheduling for the data source.
  • minimumScheduleInterval? string - The minimum interval for scheduler to schedule runs.
  • name? string - Output only. Data source resource name.
  • scopes? string[] - Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery
  • supportsCustomSchedule? boolean - Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to true, user can override default schedule.
  • supportsMultipleTransfers? boolean - Deprecated. This field has no effect.
  • transferType? string - Deprecated. This field has no effect.
  • updateDeadlineSeconds? int - The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.

googleapis.bigquery.datatransfer: DataSourceParameter

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.

Fields
  • allowedValues? string[] - All possible values for the parameter.
  • deprecated? boolean - If true, it should not be used in new transfers, and it should not be visible to users.
  • description? string - Parameter description.
  • displayName? string - Parameter display name in the user interface.
  • immutable? boolean - Cannot be changed after initial creation.
  • maxValue? decimal - For integer and double values specifies maxminum allowed value.
  • minValue? decimal - For integer and double values specifies minimum allowed value.
  • paramId? string - Parameter identifier.
  • recurse? boolean - Deprecated. This field has no effect.
  • repeated? boolean - Deprecated. This field has no effect.
  • required? boolean - Is parameter required.
  • 'type? string - Parameter type.
  • validationDescription? string - Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
  • validationHelpUrl? string - URL to a help document to further explain the naming requirements.
  • validationRegex? string - Regular expression which can be used for parameter validation.

googleapis.bigquery.datatransfer: EmailPreferences

Represents preferences for sending email notifications for transfer run events.

Fields
  • enableFailureEmail? boolean - If true, email notifications will be sent on transfer run failures.

googleapis.bigquery.datatransfer: ListDataSourcesResponse

Returns list of supported data sources and their metadata.

Fields
  • dataSources? DataSource[] - List of supported data sources and their transfer settings.
  • nextPageToken? string - Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListDataSourcesRequest.page_token to request the next page of list results.

googleapis.bigquery.datatransfer: ListLocationsResponse

The response message for Locations.ListLocations.

Fields
  • locations? Location[] - A list of locations that matches the specified filter in the request.
  • nextPageToken? string - The standard List next-page token.

googleapis.bigquery.datatransfer: ListTransferConfigsResponse

The returned list of pipelines in the project.

Fields
  • nextPageToken? string - Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListTransferConfigsRequest.page_token to request the next page of list results.
  • transferConfigs? TransferConfig[] - Output only. The stored pipeline transfer configurations.

googleapis.bigquery.datatransfer: ListTransferLogsResponse

The returned list transfer run messages.

Fields
  • nextPageToken? string - Output only. The next-pagination token. For multiple-page list results, this token can be used as the GetTransferRunLogRequest.page_token to request the next page of list results.
  • transferMessages? TransferMessage[] - Output only. The stored pipeline transfer messages.

googleapis.bigquery.datatransfer: ListTransferRunsResponse

The returned list of pipelines in the project.

Fields
  • nextPageToken? string - Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListTransferRunsRequest.page_token to request the next page of list results.
  • transferRuns? TransferRun[] - Output only. The stored pipeline transfer runs.

googleapis.bigquery.datatransfer: Location

A resource that represents Google Cloud Platform location.

Fields
  • displayName? string - The friendly name for this location, typically a nearby city name. For example, "Tokyo".
  • labels? record {} - Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
  • locationId? string - The canonical id for this location. For example: "us-east1".
  • metadata? record {} - Service-specific metadata. For example the available capacity at the given location.
  • name? string - Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

googleapis.bigquery.datatransfer: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.bigquery.datatransfer: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

googleapis.bigquery.datatransfer: ScheduleOptions

Options customizing the data transfer schedule.

Fields
  • disableAutoScheduling? boolean - 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.
  • endTime? string - Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.
  • startTime? string - Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be trigerred manually is not limited by this option.

googleapis.bigquery.datatransfer: ScheduleTransferRunsRequest

A request to schedule transfer runs for a time range.

Fields
  • endTime? string - Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".
  • startTime? string - Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

googleapis.bigquery.datatransfer: ScheduleTransferRunsResponse

A response to schedule transfer runs for a time range.

Fields
  • runs? TransferRun[] - The transfer runs that were scheduled.

googleapis.bigquery.datatransfer: StartManualTransferRunsRequest

A request to start manual transfer runs.

Fields
  • requestedRunTime? string - Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
  • requestedTimeRange? TimeRange - A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).

googleapis.bigquery.datatransfer: StartManualTransferRunsResponse

A response to start manual transfer runs.

Fields
  • runs? TransferRun[] - The transfer runs that were created.

googleapis.bigquery.datatransfer: Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Fields
  • code? int - The status code, which should be an enum value of google.rpc.Code.
  • details? record {}[] - A list of messages that carry the error details. There is a common set of message types for APIs to use.
  • message? string - A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

googleapis.bigquery.datatransfer: TimeRange

A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).

Fields
  • endTime? string - End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00". The end_time must not be in the future. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).
  • startTime? string - Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00". The start_time must be strictly less than the end_time. Creates transfer runs where run_time is in the range between start_time (inclusive) and end_time (exclusive).

googleapis.bigquery.datatransfer: TransferConfig

Represents a data transfer configuration. A transfer configuration contains all metadata needed to perform a data transfer. For example, destination_dataset_id specifies where data should be stored. When a new transfer configuration is created, the specified destination_dataset_id is created when needed and shared with the appropriate data source service account.

Fields
  • dataRefreshWindowDays? int - The number of days to look back to automatically refresh the data. For example, if data_refresh_window_days = 10, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value.
  • dataSourceId? string - Data source id. Cannot be changed once data transfer is created.
  • datasetRegion? string - Output only. Region in which BigQuery dataset is located.
  • destinationDatasetId? string - The BigQuery target dataset id.
  • disabled? boolean - Is this config disabled. When set to true, no runs are scheduled for a given transfer.
  • displayName? string - User specified display name for the data transfer.
  • emailPreferences? EmailPreferences - Represents preferences for sending email notifications for transfer run events.
  • name? string - The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/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.
  • nextRunTime? string - Output only. Next time when data transfer will run.
  • notificationPubsubTopic? string - Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
  • params? record {} - Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
  • schedule? string - Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
  • scheduleOptions? ScheduleOptions - Options customizing the data transfer schedule.
  • state? string - Output only. State of the most recently updated transfer run.
  • updateTime? string - Output only. Data transfer modification time. Ignored by server on input.
  • userId? string - Deprecated. Unique ID of the user on whose behalf transfer is done.

googleapis.bigquery.datatransfer: TransferMessage

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

Fields
  • messageText? string - Message text.
  • messageTime? string - Time when message was logged.
  • severity? string - Message severity.

googleapis.bigquery.datatransfer: TransferRun

Represents a data transfer run.

Fields
  • dataSourceId? string - Output only. Data source id.
  • destinationDatasetId? string - Output only. The BigQuery target dataset id.
  • emailPreferences? EmailPreferences - Represents preferences for sending email notifications for transfer run events.
  • endTime? string - Output only. Time when transfer run ended. Parameter ignored by server for input requests.
  • errorStatus? Status - The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
  • name? string - 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.
  • notificationPubsubTopic? string - Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes
  • params? record {} - Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq
  • runTime? string - For batch transfer runs, specifies the date and time of the data should be ingested.
  • schedule? string - Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so schedule_time doesn't always match this.
  • scheduleTime? string - Minimum time after which a transfer run can be started.
  • startTime? string - Output only. Time when transfer run was started. Parameter ignored by server for input requests.
  • state? string - Data transfer run state. Ignored for input requests.
  • updateTime? string - Output only. Last time the data transfer run state was updated.
  • userId? string - Deprecated. Unique ID of the user on whose behalf transfer is done.

Import

import ballerinax/googleapis.bigquery.datatransfer;Copy

Other versions

1.5.2

1.5.11.5.01.4.01.2.0
See more...

Metadata

Released date: 3 days ago

Version: 1.5.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 36

Current verison: 0

Weekly downloads

Source repository

Keywords

Type/Connector

IT Operations/Cloud Services

Cost/Freemium

Vendor/Google

Area/Cloud & Infrastructure

Contributors

Dependencies

ballerina/url/2.4.0ballerina/http/2.10.24

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2026 WSO2 LLC