Types for Google Cloud Bigquery Datatransfer v1 API¶
- class google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- class google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA response indicating whether the credentials exist and are valid.
- class google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- 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.
- Type
- transfer_config¶
Required. Data transfer configuration to create.
- authorization_code¶
Deprecated: Authorization code was required when
transferConfig.dataSourceIdis ‘youtube_channel’ but it is no longer used in any data sources. Useversion_infoinstead.Optional OAuth2 authorization code to use with this transfer configuration. This is required only if
transferConfig.dataSourceIdis ‘youtube_channel’ and new credentials are needed, as indicated byCheckValidCreds. In order to obtain authorization_code, make a request to the following URL:https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_nameis used to create the transfer config.- Type
- version_info¶
Optional version info. This parameter replaces
authorization_codewhich is no longer used in any data sources. This is required only iftransferConfig.dataSourceIdis ‘youtube_channel’ or new credentials are needed, as indicated byCheckValidCreds. In order to obtain version info, make a request to the following URL:https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_nameis used to create the transfer config.- Type
- service_account_name¶
Optional service account email. If this field is set, the transfer config will be created with this service account’s credentials. It requires that the requesting user calling this API has permissions to act as this service account.
Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
- Type
- class google.cloud.bigquery_datatransfer_v1.types.DataSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageDefines the properties and custom parameters for a data source.
- 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
- Type
MutableSequence[str]
- transfer_type¶
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.
- Type
- default_schedule¶
Default data transfer schedule. Examples of valid schedules include:
1st,3rd monday of month 15:30,every wed,fri of jan,jun 13:15, andfirst sunday of quarter 00:00.- Type
- supports_custom_schedule¶
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.- Type
- parameters¶
Data source parameters.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter]
- 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
data_refresh_type=SLIDING_WINDOW.- Type
- minimum_schedule_interval¶
The minimum interval for scheduler to schedule runs.
- class AuthorizationType(value)[source]¶
Bases:
proto.enums.EnumThe type of authorization needed for this data source.
- Values:
- AUTHORIZATION_TYPE_UNSPECIFIED (0):
Type unspecified.
- AUTHORIZATION_CODE (1):
Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend.
- GOOGLE_PLUS_AUTHORIZATION_CODE (2):
Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend.
- FIRST_PARTY_OAUTH (3):
Use First Party OAuth.
- class DataRefreshType(value)[source]¶
Bases:
proto.enums.EnumRepresents how the data source supports data auto refresh.
- Values:
- DATA_REFRESH_TYPE_UNSPECIFIED (0):
The data source won’t support data auto refresh, which is default value.
- SLIDING_WINDOW (1):
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 (2):
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.
- class google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA parameter used to define custom fields in a data source definition.
- type_¶
Parameter type.
- min_value¶
For integer and double values specifies minimum allowed value.
- max_value¶
For integer and double values specifies maximum allowed value.
- fields¶
Deprecated. This field has no effect.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter]
- validation_description¶
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
- Type
- deprecated¶
If true, it should not be used in new transfers, and it should not be visible to users.
- Type
- class Type(value)[source]¶
Bases:
proto.enums.EnumParameter type.
- Values:
- TYPE_UNSPECIFIED (0):
Type unspecified.
- STRING (1):
String parameter.
- INTEGER (2):
Integer parameter (64-bits). Will be serialized to json as string.
- DOUBLE (3):
Double precision floating point parameter.
- BOOLEAN (4):
Boolean parameter.
- RECORD (5):
Deprecated. This field has no effect.
- PLUS_PAGE (6):
Page ID for a Google+ Page.
- LIST (7):
List of strings parameter.
- class google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
- class google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to delete data transfer run information.
- class google.cloud.bigquery_datatransfer_v1.types.EmailPreferences(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents preferences for sending email notifications for transfer run events.
- class google.cloud.bigquery_datatransfer_v1.types.EncryptionConfiguration(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents the encryption configuration for a transfer.
- kms_key_name¶
The name of the KMS key used for encrypting BigQuery data.
- class google.cloud.bigquery_datatransfer_v1.types.EnrollDataSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to enroll a set of data sources so they are visible in the BigQuery UI’s
Transfertab.
- class google.cloud.bigquery_datatransfer_v1.types.EventDrivenSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions customizing EventDriven transfers schedule.
- class google.cloud.bigquery_datatransfer_v1.types.GetDataSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to get data source info.
- class google.cloud.bigquery_datatransfer_v1.types.GetTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to get data transfer information.
- class google.cloud.bigquery_datatransfer_v1.types.GetTransferRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to get data transfer run information.
- class google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRequest to list supported data sources and their data transfer settings.
- parent¶
Required. The BigQuery project id for which data sources should be returned. Must be in the form:
projects/{project_id}orprojects/{project_id}/locations/{location_id}- Type
- page_token¶
Pagination token, which can be used to request a specific page of
ListDataSourcesRequestlist results. For multiple-page results,ListDataSourcesResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results.- Type
- class google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageReturns list of supported data sources and their metadata.
- data_sources¶
List of supported data sources and their transfer settings.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.DataSource]
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to list data transfers configured for a BigQuery project.
- parent¶
Required. The BigQuery project id for which transfer configs should be returned:
projects/{project_id}orprojects/{project_id}/locations/{location_id}- Type
- data_source_ids¶
When specified, only configurations of requested data sources are returned.
- Type
MutableSequence[str]
- page_token¶
Pagination token, which can be used to request a specific page of
ListTransfersRequestlist results. For multiple-page results,ListTransfersResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results.- Type
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe returned list of pipelines in the project.
- transfer_configs¶
Output only. The stored pipeline transfer configurations.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferConfig]
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to get user facing log messages associated with data transfer run.
- parent¶
Required. Transfer run name in the form:
projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}- Type
- page_token¶
Pagination token, which can be used to request a specific page of
ListTransferLogsRequestlist results. For multiple-page results,ListTransferLogsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results.- Type
- message_types¶
Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferMessage.MessageSeverity]
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe returned list transfer run messages.
- transfer_messages¶
Output only. The stored pipeline transfer messages.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferMessage]
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to list data transfer runs.
- parent¶
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}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.- Type
- states¶
When specified, only transfer runs with requested states are returned.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferState]
- page_token¶
Pagination token, which can be used to request a specific page of
ListTransferRunsRequestlist results. For multiple-page results,ListTransferRunsResponseoutputs anext_pagetoken, which can be used as thepage_tokenvalue to request the next page of list results.- Type
- run_attempt¶
Indicates how run attempts are to be pulled.
- class RunAttempt(value)[source]¶
Bases:
proto.enums.EnumRepresents which runs should be pulled.
- Values:
- RUN_ATTEMPT_UNSPECIFIED (0):
All runs should be returned.
- LATEST (1):
Only latest run per day should be returned.
- class google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageThe returned list of pipelines in the project.
- transfer_runs¶
Output only. The stored pipeline transfer runs.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]
- class google.cloud.bigquery_datatransfer_v1.types.ManualSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions customizing manual transfers schedule.
- class google.cloud.bigquery_datatransfer_v1.types.ScheduleOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions customizing the data transfer schedule.
- 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.
- Type
- 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 triggered 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 triggered manually is not limited by this option.
- class google.cloud.bigquery_datatransfer_v1.types.ScheduleOptionsV2(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageV2 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.
- time_based_schedule¶
Time based transfer schedule options. This is the default schedule option.
This field is a member of oneof
schedule.
- manual_schedule¶
Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
This field is a member of oneof
schedule.
- class google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to schedule transfer runs for a time range.
- parent¶
Required. Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.- Type
- start_time¶
Required. Start time of the range of transfer runs. For example,
"2017-05-25T00:00:00+00:00".
- end_time¶
Required. End time of the range of transfer runs. For example,
"2017-05-30T00:00:00+00:00".
- class google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA response to schedule transfer runs for a time range.
- runs¶
The transfer runs that were scheduled.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]
- class google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- parent¶
Required. Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}orprojects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.- Type
- requested_time_range¶
A time_range start and end timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_time_range must be a past time and cannot include future time values.
This field is a member of oneof
time.
- requested_run_time¶
A run_time timestamp for historical data files or reports that are scheduled to be transferred by the scheduled transfer run. requested_run_time must be a past time and cannot include future time values.
This field is a member of oneof
time.
- class TimeRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).
- start_time¶
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).
- end_time¶
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).
- class google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA response to start manual transfer runs.
- runs¶
The transfer runs that were created.
- Type
MutableSequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]
- class google.cloud.bigquery_datatransfer_v1.types.TimeBasedSchedule(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageOptions customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.
- 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:
1st,3rd monday of month 15:30,every wed,fri of jan,jun 13:15, andfirst 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_formatNOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Type
- 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.
- 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.
- class google.cloud.bigquery_datatransfer_v1.types.TransferConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents 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.- name¶
Identifier. The resource name of the transfer config. Transfer config names have the form either
projects/{project_id}/locations/{region}/transferConfigs/{config_id}orprojects/{project_id}/transferConfigs/{config_id}, whereconfig_idis usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config.- Type
- destination_dataset_id¶
The BigQuery target dataset id.
This field is a member of oneof
destination.- Type
- data_source_id¶
Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call:
- Type
- params¶
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¶
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, andfirst 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_formatNOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
- Type
- schedule_options¶
Options customizing the data transfer schedule.
- schedule_options_v2¶
Options customizing different types of data transfer schedule. This field replaces “schedule” and “schedule_options” fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.
- data_refresh_window_days¶
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.- Type
- disabled¶
Is this config disabled. When set to true, no runs will be scheduled for this transfer config.
- Type
- 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.
- notification_pubsub_topic¶
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
The format for specifying a pubsub topic is:
projects/{project_id}/topics/{topic_id}- Type
- email_preferences¶
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
- owner_info¶
Output only. Information about the user whose credentials are used to transfer data. Populated only for
transferConfigs.getrequests. In case the user information is not available, this field will not be populated.This field is a member of oneof
_owner_info.
- encryption_configuration¶
The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.
- error¶
Output only. Error code with detailed information about reason of the latest config failure.
- Type
google.rpc.status_pb2.Status
- class google.cloud.bigquery_datatransfer_v1.types.TransferMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a user facing message for a particular data transfer run.
- message_time¶
Time when message was logged.
- severity¶
Message severity.
- class MessageSeverity(value)[source]¶
Bases:
proto.enums.EnumRepresents data transfer user facing message severity.
- Values:
- MESSAGE_SEVERITY_UNSPECIFIED (0):
No severity specified.
- INFO (1):
Informational message.
- WARNING (2):
Warning message.
- ERROR (3):
Error message.
- class google.cloud.bigquery_datatransfer_v1.types.TransferRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageRepresents a data transfer run.
- name¶
Identifier. 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.- Type
- 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.
- Type
google.rpc.status_pb2.Status
- 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. 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
- destination_dataset_id¶
Output only. The BigQuery target dataset id.
This field is a member of oneof
destination.- Type
- state¶
Data transfer run state. Ignored for input requests.
- 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
schedule_timedoesn’t always match this.- Type
- notification_pubsub_topic¶
Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes.
The format for specifying a pubsub topic is:
projects/{project_id}/topics/{topic_id}- Type
- 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.
- class google.cloud.bigquery_datatransfer_v1.types.TransferState(value)[source]¶
Bases:
proto.enums.EnumRepresents 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).
- class google.cloud.bigquery_datatransfer_v1.types.TransferType(value)[source]¶
Bases:
proto.enums.EnumDEPRECATED. 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.
- class google.cloud.bigquery_datatransfer_v1.types.UnenrollDataSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA request to unenroll a set of data sources so they are no longer visible in the BigQuery UI’s
Transfertab.
- class google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶
Bases:
proto.message.MessageA 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.
- transfer_config¶
Required. Data transfer configuration to create.
- authorization_code¶
Deprecated: Authorization code was required when
transferConfig.dataSourceIdis ‘youtube_channel’ but it is no longer used in any data sources. Useversion_infoinstead.Optional OAuth2 authorization code to use with this transfer configuration. This is required only if
transferConfig.dataSourceIdis ‘youtube_channel’ and new credentials are needed, as indicated byCheckValidCreds. In order to obtain authorization_code, make a request to the following URL:https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_nameis used to update the transfer config.- Type
- update_mask¶
Required. Required list of fields to be updated in this request.
- version_info¶
Optional version info. This parameter replaces
authorization_codewhich is no longer used in any data sources. This is required only iftransferConfig.dataSourceIdis ‘youtube_channel’ or new credentials are needed, as indicated byCheckValidCreds. In order to obtain version info, make a request to the following URL:https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
The client_id is the OAuth client_id of the data source as returned by ListDataSources method.
data_source_scopes are the scopes returned by ListDataSources method.
Note that this should not be set when
service_account_nameis used to update the transfer config.- Type
- service_account_name¶
Optional service account email. If this field is set, the transfer config will be created with this service account’s credentials. It requires that the requesting user calling this API has permissions to act as this service account.
Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, read about using service accounts.
- Type
