Index
DataTransferService
(interface)CheckValidCredsRequest
(message)CheckValidCredsResponse
(message)CreateTransferConfigRequest
(message)DataSource
(message)DataSource.AuthorizationType
(enum)DataSource.DataRefreshType
(enum)DataSourceParameter
(message)DataSourceParameter.Type
(enum)DeleteTransferConfigRequest
(message)DeleteTransferRunRequest
(message)EmailPreferences
(message)GetDataSourceRequest
(message)GetTransferConfigRequest
(message)GetTransferRunRequest
(message)ListDataSourcesRequest
(message)ListDataSourcesResponse
(message)ListTransferConfigsRequest
(message)ListTransferConfigsResponse
(message)ListTransferLogsRequest
(message)ListTransferLogsResponse
(message)ListTransferRunsRequest
(message)ListTransferRunsRequest.RunAttempt
(enum)ListTransferRunsResponse
(message)ScheduleOptions
(message)ScheduleTransferRunsRequest
(message)ScheduleTransferRunsResponse
(message)StartManualTransferRunsRequest
(message)StartManualTransferRunsRequest.TimeRange
(message)StartManualTransferRunsResponse
(message)TransferConfig
(message)TransferMessage
(message)TransferMessage.MessageSeverity
(enum)TransferRun
(message)TransferState
(enum)TransferType
(enum) (deprecated)UpdateTransferConfigRequest
(message)
DataTransferService
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.
CheckValidCreds | |
---|---|
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.
|
CreateTransferConfig | |
---|---|
Creates a new data transfer configuration.
|
DeleteTransferConfig | |
---|---|
Deletes a data transfer configuration, including any associated transfer runs and logs.
|
DeleteTransferRun | |
---|---|
Deletes the specified transfer run.
|
GetDataSource | |
---|---|
Retrieves a supported data source and returns its settings, which can be used for UI rendering.
|
GetTransferConfig | |
---|---|
Returns information about a data transfer config.
|
GetTransferRun | |
---|---|
Returns information about the particular transfer run.
|
ListDataSources | |
---|---|
Lists supported data sources and returns their settings, which can be used for UI rendering.
|
ListTransferConfigs | |
---|---|
Returns information about all data transfers in the project.
|
ListTransferLogs | |
---|---|
Returns user facing log messages for the data transfer run.
|
ListTransferRuns | |
---|---|
Returns information about running and completed jobs.
|
ScheduleTransferRuns | |
---|---|
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.
|
StartManualTransferRuns | |
---|---|
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.
|
UpdateTransferConfig | |
---|---|
Updates a data transfer configuration. All fields must be set, even if they are not updated.
|
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.
Fields | |
---|---|
name |
Required. The data source in the form: Authorization requires the following IAM permission on the specified resource
|
CheckValidCredsResponse
A response indicating whether the credentials exist and are valid.
Fields | |
---|---|
has_valid_creds |
If set to |
CreateTransferConfigRequest
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.
Fields | |
---|---|
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. Authorization requires the following IAM permission on the specified resource
|
transfer_config |
Required. Data transfer configuration to create. |
authorization_code |
Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by
|
version_info |
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. |
service_account_name |
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. |
DataSource
Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
Fields | |
---|---|
name |
Output only. Data source resource name. |
data_source_id |
Data source id. |
display_name |
User friendly data source name. |
description |
User friendly data source description string. |
client_id |
Data source client id which should be used to receive refresh token. |
scopes[] |
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 |
transfer_type |
Deprecated. This field has no effect. |
supports_multiple_transfers |
Deprecated. This field has no effect. |
update_deadline_seconds |
The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. |
default_schedule |
Default data transfer schedule. Examples of valid schedules include: |
supports_custom_schedule |
Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to |
parameters[] |
Data source parameters. |
help_url |
Url for the help document for this data source. |
authorization_type |
Indicates the type of authorization. |
data_refresh_type |
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. |
default_data_refresh_window_days |
Default data refresh window on days. Only meaningful when |
manual_runs_disabled |
Disables backfilling and manual run scheduling for the data source. |
minimum_schedule_interval |
The minimum interval for scheduler to schedule runs. |
AuthorizationType
The type of authorization needed for this data source.
Enums | |
---|---|
AUTHORIZATION_TYPE_UNSPECIFIED |
Type unspecified. |
AUTHORIZATION_CODE |
Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend. |
GOOGLE_PLUS_AUTHORIZATION_CODE |
Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend. |
FIRST_PARTY_OAUTH |
Use First Party OAuth based on Loas Owned Clients. First Party OAuth doesn't require a refresh token to get an offline access token. Instead, it uses a client-signed JWT assertion to retrieve an access token. |
DataRefreshType
Represents how the data source supports data auto refresh.
Enums | |
---|---|
DATA_REFRESH_TYPE_UNSPECIFIED |
The data source won't support data auto refresh, which is default value. |
SLIDING_WINDOW |
The data source supports data auto refresh, and runs will be scheduled for the past few days. Does not allow custom values to be set for each transfer config. |
CUSTOM_SLIDING_WINDOW |
The data source supports data auto refresh, and runs will be scheduled for the past few days. Allows custom values to be set for each transfer config. |
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 | |
---|---|
param_id |
Parameter identifier. |
display_name |
Parameter display name in the user interface. |
description |
Parameter description. |
type |
Parameter type. |
required |
Is parameter required. |
repeated |
Deprecated. This field has no effect. |
validation_regex |
Regular expression which can be used for parameter validation. |
allowed_values[] |
All possible values for the parameter. |
min_value |
For integer and double values specifies minimum allowed value. |
max_value |
For integer and double values specifies maxminum allowed value. |
fields[] |
Deprecated. This field has no effect. |
validation_description |
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values. |
validation_help_url |
URL to a help document to further explain the naming requirements. |
immutable |
Cannot be changed after initial creation. |
recurse |
Deprecated. This field has no effect. |
deprecated |
If true, it should not be used in new transfers, and it should not be visible to users. |
Type
Parameter type.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Type unspecified. |
STRING |
String parameter. |
INTEGER |
Integer parameter (64-bits). Will be serialized to json as string. |
DOUBLE |
Double precision floating point parameter. |
BOOLEAN |
Boolean parameter. |
RECORD |
Deprecated. This field has no effect. |
PLUS_PAGE |
Page ID for a Google+ Page. |
DeleteTransferConfigRequest
A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
Fields | |
---|---|
name |
Required. The field will contain name of the resource requested, for example: Authorization requires the following IAM permission on the specified resource
|
DeleteTransferRunRequest
A request to delete data transfer run information.
Fields | |
---|---|
name |
Required. The field will contain name of the resource requested, for example: Authorization requires the following IAM permission on the specified resource
|
EmailPreferences
Represents preferences for sending email notifications for transfer run events.
Fields | |
---|---|
enable_failure_email |
If true, email notifications will be sent on transfer run failures. |
GetDataSourceRequest
A request to get data source info.
Fields | |
---|---|
name |
Required. The field will contain name of the resource requested, for example: Authorization requires the following IAM permission on the specified resource
|
GetTransferConfigRequest
A request to get data transfer information.
Fields | |
---|---|
name |
Required. The field will contain name of the resource requested, for example: Authorization requires the following IAM permission on the specified resource
|
GetTransferRunRequest
A request to get data transfer run information.
Fields | |
---|---|
name |
Required. The field will contain name of the resource requested, for example: Authorization requires the following IAM permission on the specified resource
|
ListDataSourcesRequest
Request to list supported data sources and their data transfer settings.
Fields | |
---|---|
parent |
Required. The BigQuery project id for which data sources should be returned. Must be in the form: Authorization requires the following IAM permission on the specified resource
|
page_token |
Pagination token, which can be used to request a specific page of |
page_size |
Page size. The default page size is the maximum value of 1000 results. |
ListDataSourcesResponse
Returns list of supported data sources and their metadata.
Fields | |
---|---|
data_sources[] |
List of supported data sources and their transfer settings. |
next_page_token |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the |
ListTransferConfigsRequest
A request to list data transfers configured for a BigQuery project.
Fields | |
---|---|
parent |
Required. The BigQuery project id for which data sources should be returned: Authorization requires the following IAM permission on the specified resource
|
data_source_ids[] |
When specified, only configurations of requested data sources are returned. |
page_token |
Pagination token, which can be used to request a specific page of |
page_size |
Page size. The default page size is the maximum value of 1000 results. |
ListTransferConfigsResponse
The returned list of pipelines in the project.
Fields | |
---|---|
transfer_configs[] |
Output only. The stored pipeline transfer configurations. |
next_page_token |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the |
ListTransferLogsRequest
A request to get user facing log messages associated with data transfer run.
Fields | |
---|---|
parent |
Required. Transfer run name in the form: Authorization requires the following IAM permission on the specified resource
|
page_token |
Pagination token, which can be used to request a specific page of |
page_size |
Page size. The default page size is the maximum value of 1000 results. |
message_types[] |
Message types to return. If not populated - INFO, WARNING and ERROR messages are returned. |
ListTransferLogsResponse
The returned list transfer run messages.
Fields | |
---|---|
transfer_messages[] |
Output only. The stored pipeline transfer messages. |
next_page_token |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the |
ListTransferRunsRequest
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.
Fields | |
---|---|
parent |
Required. Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is: Authorization requires the following IAM permission on the specified resource
|
states[] |
When specified, only transfer runs with requested states are returned. |
page_token |
Pagination token, which can be used to request a specific page of |
page_size |
Page size. The default page size is the maximum value of 1000 results. |
run_attempt |
Indicates how run attempts are to be pulled. |
RunAttempt
Represents which runs should be pulled.
Enums | |
---|---|
RUN_ATTEMPT_UNSPECIFIED |
All runs should be returned. |
LATEST |
Only latest run per day should be returned. |
ListTransferRunsResponse
The returned list of pipelines in the project.
Fields | |
---|---|
transfer_runs[] |
Output only. The stored pipeline transfer runs. |
next_page_token |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the |
ScheduleOptions
Options customizing the data transfer schedule.
Fields | |
---|---|
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. |
start_time |
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. |
end_time |
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. |
ScheduleTransferRunsRequest
A request to schedule transfer runs for a time range.
Fields | |
---|---|
parent |
Required. Transfer configuration name in the form: Authorization requires the following IAM permission on the specified resource
|
start_time |
Required. Start time of the range of transfer runs. For example, |
end_time |
Required. End time of the range of transfer runs. For example, |
ScheduleTransferRunsResponse
A response to schedule transfer runs for a time range.
Fields | |
---|---|
runs[] |
The transfer runs that were scheduled. |
StartManualTransferRunsRequest
A request to start manual transfer runs.
Fields | ||
---|---|---|
parent |
Transfer configuration name in the form: Authorization requires the following IAM permission on the specified resource
|
|
Union field time . The requested time specification - this can be a time range or a specific run_time. time can be only one of the following: |
||
requested_time_range |
Time range for the transfer runs that should be started. |
|
requested_run_time |
Specific run_time for a transfer run to be started. The requested_run_time must not be in the future. |
TimeRange
A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
Fields | |
---|---|
start_time |
Start time of the range of transfer runs. For example, |
end_time |
End time of the range of transfer runs. For example, |
StartManualTransferRunsResponse
A response to start manual transfer runs.
Fields | |
---|---|
runs[] |
The transfer runs that were created. |
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 | |
---|---|
name |
The resource name of the transfer config. Transfer config names have the form of |
display_name |
User specified display name for the data transfer. |
data_source_id |
Data source id. Cannot be changed once data transfer is created. |
params |
Data transfer specific parameters. |
schedule |
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: |
schedule_options |
Options customizing the data transfer schedule. |
data_refresh_window_days |
The number of days to look back to automatically refresh the data. For example, if |
disabled |
Is this config disabled. When set to true, no runs are scheduled for a given transfer. |
update_time |
Output only. Data transfer modification time. Ignored by server on input. |
next_run_time |
Output only. Next time when data transfer will run. |
state |
Output only. State of the most recently updated transfer run. |
user_id |
Deprecated. Unique ID of the user on whose behalf transfer is done. |
dataset_region |
Output only. Region in which BigQuery dataset is located. |
notification_pubsub_topic |
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. |
email_preferences |
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. |
destination_dataset_id |
The BigQuery target dataset id. |
TransferMessage
Represents a user facing message for a particular data transfer run.
Fields | |
---|---|
message_time |
Time when message was logged. |
severity |
Message severity. |
message_text |
Message text. |
MessageSeverity
Represents data transfer user facing message severity.
Enums | |
---|---|
MESSAGE_SEVERITY_UNSPECIFIED |
No severity specified. |
INFO |
Informational message. |
WARNING |
Warning message. |
ERROR |
Error message. |
TransferRun
Represents a data transfer run.
Fields | |
---|---|
name |
The resource name of the transfer run. Transfer run names have the form |
schedule_time |
Minimum time after which a transfer run can be started. |
run_time |
For batch transfer runs, specifies the date and time of the data should be ingested. |
error_status |
Status of the transfer run. |
start_time |
Output only. Time when transfer run was started. Parameter ignored by server for input requests. |
end_time |
Output only. Time when transfer run ended. Parameter ignored by server for input requests. |
update_time |
Output only. Last time the data transfer run state was updated. |
params |
Output only. Data transfer specific parameters. |
data_source_id |
Output only. Data source id. |
state |
Data transfer run state. Ignored for input requests. |
user_id |
Deprecated. Unique ID of the user on whose behalf transfer is done. |
schedule |
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 |
notification_pubsub_topic |
Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes |
email_preferences |
Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from. |
destination_dataset_id |
Output only. The BigQuery target dataset id. |
TransferState
Represents data transfer run state.
Enums | |
---|---|
TRANSFER_STATE_UNSPECIFIED |
State placeholder. |
PENDING |
Data transfer is scheduled and is waiting to be picked up by data transfer backend. |
RUNNING |
Data transfer is in progress. |
SUCCEEDED |
Data transfer completed successfully. |
FAILED |
Data transfer failed. |
CANCELLED |
Data transfer is cancelled. |
TransferType
DEPRECATED. Represents data transfer type.
Enums | |
---|---|
TRANSFER_TYPE_UNSPECIFIED |
Invalid or Unknown transfer type placeholder. |
BATCH |
Batch data transfer. |
STREAMING |
Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project. |
UpdateTransferConfigRequest
A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.
Fields | |
---|---|
transfer_config |
Required. Data transfer configuration to create. Authorization requires the following IAM permission on the specified resource
|
authorization_code |
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=
|
update_mask |
Required. Required list of fields to be updated in this request. |
version_info |
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. |
service_account_name |
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. |