Expand description
The messages and enums that are part of this client library.
Modules§
- data_
source - Defines additional types related to DataSource.
- data_
source_ parameter - Defines additional types related to DataSourceParameter.
- list_
transfer_ runs_ request - Defines additional types related to ListTransferRunsRequest.
- schedule_
options_ v_ 2 - Defines additional types related to ScheduleOptionsV2.
- start_
manual_ transfer_ runs_ request - Defines additional types related to StartManualTransferRunsRequest.
- transfer_
config - Defines additional types related to TransferConfig.
- transfer_
message - Defines additional types related to TransferMessage.
- transfer_
run - Defines additional types related to TransferRun.
Structs§
- Check
Valid Creds Request - 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.
- Check
Valid Creds Response - A response indicating whether the credentials exist and are valid.
- Create
Transfer Config Request - A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. Otherwise, the transfer configuration will be associated with the calling user.
- Data
Source - Defines the properties and custom parameters for a data source.
- Data
Source Parameter - A parameter used to define custom fields in a data source definition.
- Delete
Transfer Config Request - A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
- Delete
Transfer RunRequest - A request to delete data transfer run information.
- Email
Preferences - Represents preferences for sending email notifications for transfer run events.
- Encryption
Configuration - Represents the encryption configuration for a transfer.
- Enroll
Data Sources Request - A request to enroll a set of data sources so they are visible in the
BigQuery UI’s
Transfertab. - Event
Driven Schedule - Options customizing EventDriven transfers schedule.
- GetData
Source Request - A request to get data source info.
- GetTransfer
Config Request - A request to get data transfer information.
- GetTransfer
RunRequest - A request to get data transfer run information.
- List
Data Sources Request - Request to list supported data sources and their data transfer settings.
- List
Data Sources Response - Returns list of supported data sources and their metadata.
- List
Transfer Configs Request - A request to list data transfers configured for a BigQuery project.
- List
Transfer Configs Response - The returned list of pipelines in the project.
- List
Transfer Logs Request - A request to get user facing log messages associated with data transfer run.
- List
Transfer Logs Response - The returned list transfer run messages.
- List
Transfer Runs Request - A request to list data transfer runs.
- List
Transfer Runs Response - The returned list of pipelines in the project.
- Manual
Schedule - Options customizing manual transfers schedule.
- Schedule
Options - Options customizing the data transfer schedule.
- Schedule
Options V2 - V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
- Schedule
Transfer Runs Request - A request to schedule transfer runs for a time range.
- Schedule
Transfer Runs Response - A response to schedule transfer runs for a time range.
- Start
Manual Transfer Runs Request - A request to start manual transfer runs.
- Start
Manual Transfer Runs Response - A response to start manual transfer runs.
- Time
Based Schedule - Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
- Transfer
Config - Represents a data transfer configuration. A transfer configuration
contains all metadata needed to perform a data transfer. For example,
destination_dataset_idspecifies where data should be stored. When a new transfer configuration is created, the specifieddestination_dataset_idis created when needed and shared with the appropriate data source service account. - Transfer
Message - Represents a user facing message for a particular data transfer run.
- Transfer
Run - Represents a data transfer run.
- Unenroll
Data Sources Request - A request to unenroll a set of data sources so they are no longer visible in
the BigQuery UI’s
Transfertab. - Update
Transfer Config Request - A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
- User
Info - Information about a user.
Enums§
- Transfer
State - Represents data transfer run state.
- Transfer
Type Deprecated - DEPRECATED. Represents data transfer type.