API documentation for bigquery_datatransfer_v1.types package.
Classes
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.
CheckValidCredsResponse
A response indicating whether the credentials exist and are valid.
CreateTransferConfigRequest
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.
DataSource
Defines the properties and custom parameters for a data source.
DataSourceParameter
A parameter used to define custom fields in a data source definition.
DeleteTransferConfigRequest
A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
DeleteTransferRunRequest
A request to delete data transfer run information.
EmailPreferences
Represents preferences for sending email notifications for transfer run events.
EnrollDataSourcesRequest
A request to enroll a set of data sources so they are visible in the
BigQuery UI's Transfer tab.
GetDataSourceRequest
A request to get data source info.
GetTransferConfigRequest
A request to get data transfer information.
GetTransferRunRequest
A request to get data transfer run information.
ListDataSourcesRequest
Request to list supported data sources and their data transfer settings.
ListDataSourcesResponse
Returns list of supported data sources and their metadata.
ListTransferConfigsRequest
A request to list data transfers configured for a BigQuery project.
ListTransferConfigsResponse
The returned list of pipelines in the project.
ListTransferLogsRequest
A request to get user facing log messages associated with data transfer run.
ListTransferLogsResponse
The returned list transfer run messages.
ListTransferRunsRequest
A request to list data transfer runs.
ListTransferRunsResponse
The returned list of pipelines in the project.
ScheduleOptions
Options customizing the data transfer schedule.
ScheduleTransferRunsRequest
A request to schedule transfer runs for a time range.
ScheduleTransferRunsResponse
A response to schedule transfer runs for a time range.
StartManualTransferRunsRequest
A request to start manual transfer runs.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StartManualTransferRunsResponse
A response to start manual transfer runs.
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.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TransferMessage
Represents a user facing message for a particular data transfer run.
TransferRun
Represents a data transfer run.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TransferState
Represents data transfer run state.
Values: TRANSFER_STATE_UNSPECIFIED (0): State placeholder (0). PENDING (2): Data transfer is scheduled and is waiting to be picked up by data transfer backend (2). RUNNING (3): Data transfer is in progress (3). SUCCEEDED (4): Data transfer completed successfully (4). FAILED (5): Data transfer failed (5). CANCELLED (6): Data transfer is cancelled (6).
TransferType
DEPRECATED. Represents data transfer type.
Values: TRANSFER_TYPE_UNSPECIFIED (0): Invalid or Unknown transfer type placeholder. BATCH (1): Batch data transfer. STREAMING (2): 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, authorization info needs to be provided.
UserInfo
Information about a user.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields