Summary of entries of Classes for bigquerydatatransfer.
Classes
DataTransferServiceAsyncClient
This API allows users to manage their data transfers into BigQuery.
DataTransferServiceClient
This API allows users to manage their data transfers into BigQuery.
ListDataSourcesAsyncPager
A pager for iterating through list_data_sources
requests.
This class thinly wraps an initial
ListDataSourcesResponse object, and
provides an __aiter__
method to iterate through its
data_sources
field.
If there are more pages, the __aiter__
method will make additional
ListDataSources
requests and continue to iterate
through the data_sources
field on the
corresponding responses.
All the usual ListDataSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListDataSourcesPager
A pager for iterating through list_data_sources
requests.
This class thinly wraps an initial
ListDataSourcesResponse object, and
provides an __iter__
method to iterate through its
data_sources
field.
If there are more pages, the __iter__
method will make additional
ListDataSources
requests and continue to iterate
through the data_sources
field on the
corresponding responses.
All the usual ListDataSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferConfigsAsyncPager
A pager for iterating through list_transfer_configs
requests.
This class thinly wraps an initial
ListTransferConfigsResponse object, and
provides an __aiter__
method to iterate through its
transfer_configs
field.
If there are more pages, the __aiter__
method will make additional
ListTransferConfigs
requests and continue to iterate
through the transfer_configs
field on the
corresponding responses.
All the usual ListTransferConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferConfigsPager
A pager for iterating through list_transfer_configs
requests.
This class thinly wraps an initial
ListTransferConfigsResponse object, and
provides an __iter__
method to iterate through its
transfer_configs
field.
If there are more pages, the __iter__
method will make additional
ListTransferConfigs
requests and continue to iterate
through the transfer_configs
field on the
corresponding responses.
All the usual ListTransferConfigsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferLogsAsyncPager
A pager for iterating through list_transfer_logs
requests.
This class thinly wraps an initial
ListTransferLogsResponse object, and
provides an __aiter__
method to iterate through its
transfer_messages
field.
If there are more pages, the __aiter__
method will make additional
ListTransferLogs
requests and continue to iterate
through the transfer_messages
field on the
corresponding responses.
All the usual ListTransferLogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferLogsPager
A pager for iterating through list_transfer_logs
requests.
This class thinly wraps an initial
ListTransferLogsResponse object, and
provides an __iter__
method to iterate through its
transfer_messages
field.
If there are more pages, the __iter__
method will make additional
ListTransferLogs
requests and continue to iterate
through the transfer_messages
field on the
corresponding responses.
All the usual ListTransferLogsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferRunsAsyncPager
A pager for iterating through list_transfer_runs
requests.
This class thinly wraps an initial
ListTransferRunsResponse object, and
provides an __aiter__
method to iterate through its
transfer_runs
field.
If there are more pages, the __aiter__
method will make additional
ListTransferRuns
requests and continue to iterate
through the transfer_runs
field on the
corresponding responses.
All the usual ListTransferRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
ListTransferRunsPager
A pager for iterating through list_transfer_runs
requests.
This class thinly wraps an initial
ListTransferRunsResponse object, and
provides an __iter__
method to iterate through its
transfer_runs
field.
If there are more pages, the __iter__
method will make additional
ListTransferRuns
requests and continue to iterate
through the transfer_runs
field on the
corresponding responses.
All the usual ListTransferRunsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.
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.
When using a cross project service account for creating a transfer
config, you must enable cross project service account usage. For
more information, see Disable attachment of service accounts to
resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>
__.
DataSource
Defines the properties and custom parameters for a data source.
AuthorizationType
The type of authorization needed for this data source.
DataRefreshType
Represents how the data source supports data auto refresh.
DataSourceParameter
A parameter used to define custom fields in a data source definition.
Type
Parameter type.
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.
EncryptionConfiguration
Represents the encryption configuration for a transfer.
EnrollDataSourcesRequest
A request to enroll a set of data sources so they are visible in the
BigQuery UI's Transfer
tab.
EventDrivenSchedule
Options customizing EventDriven transfers schedule.
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.
RunAttempt
Represents which runs should be pulled.
ListTransferRunsResponse
The returned list of pipelines in the project.
ManualSchedule
Options customizing manual transfers schedule.
ScheduleOptions
Options customizing the data transfer schedule.
ScheduleOptionsV2
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.
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
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
TimeRange
A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
StartManualTransferRunsResponse
A response to start manual transfer runs.
TimeBasedSchedule
Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
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.
MessageSeverity
Represents data transfer user facing message severity.
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.
TransferType
DEPRECATED. Represents data transfer type.
UnenrollDataSourcesRequest
A request to unenroll a set of data sources so they are no longer
visible in the BigQuery UI's Transfer
tab.
UpdateTransferConfigRequest
A request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
When using a cross project service account for updating a transfer
config, you must enable cross project service account usage. For
more information, see Disable attachment of service accounts to
resources in other
projects <https://cloud.google.com/resource-manager/docs/organization-policy/restricting-service-accounts#disable_cross_project_service_accounts>
__.
UserInfo
Information about a user.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Modules
pagers
API documentation for bigquery_datatransfer_v1.services.data_transfer_service.pagers
module.