As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

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.Message

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.

name

Required. The data source in the form: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}.

Type

str

class google.cloud.bigquery_datatransfer_v1.types.CheckValidCredsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response indicating whether the credentials exist and are valid.

has_valid_creds

If set to true, the credentials exist and are valid.

Type

bool

class google.cloud.bigquery_datatransfer_v1.types.CreateTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

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

str

transfer_config

Required. Data transfer configuration to create.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

authorization_code

Optional OAuth2 authorization code to use with this transfer configuration. This is required if new credentials are needed, as indicated by CheckValidCreds. In order to obtain authorization_code, please make a request to https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

  • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.

  • data_source_scopes are the scopes returned by ListDataSources method.

  • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

Type

str

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.

Type

str

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.

Type

str

class google.cloud.bigquery_datatransfer_v1.types.DataSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.

name

Output only. Data source resource name.

Type

str

data_source_id

Data source id.

Type

str

display_name

User friendly data source name.

Type

str

description

User friendly data source description string.

Type

str

client_id

Data source client id which should be used to receive refresh token.

Type

str

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

Sequence[str]

transfer_type

Deprecated. This field has no effect.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferType

supports_multiple_transfers

Deprecated. This field has no effect.

Type

bool

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

int

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, and first sunday of quarter 00:00.

Type

str

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

bool

parameters

Data source parameters.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter]

help_url

Url for the help document for this data source.

Type

str

authorization_type

Indicates the type of authorization.

Type

google.cloud.bigquery_datatransfer_v1.types.DataSource.AuthorizationType

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.

Type

google.cloud.bigquery_datatransfer_v1.types.DataSource.DataRefreshType

default_data_refresh_window_days

Default data refresh window on days. Only meaningful when data_refresh_type = SLIDING_WINDOW.

Type

int

manual_runs_disabled

Disables backfilling and manual run scheduling for the data source.

Type

bool

minimum_schedule_interval

The minimum interval for scheduler to schedule runs.

Type

google.protobuf.duration_pb2.Duration

class AuthorizationType(value)[source]

Bases: proto.enums.Enum

The type of authorization needed for this data source.

AUTHORIZATION_CODE = 1
AUTHORIZATION_TYPE_UNSPECIFIED = 0
FIRST_PARTY_OAUTH = 3
GOOGLE_PLUS_AUTHORIZATION_CODE = 2
class DataRefreshType(value)[source]

Bases: proto.enums.Enum

Represents how the data source supports data auto refresh.

CUSTOM_SLIDING_WINDOW = 2
DATA_REFRESH_TYPE_UNSPECIFIED = 0
SLIDING_WINDOW = 1
class google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

param_id

Parameter identifier.

Type

str

display_name

Parameter display name in the user interface.

Type

str

description

Parameter description.

Type

str

type_

Parameter type.

Type

google.cloud.bigquery_datatransfer_v1.types.DataSourceParameter.Type

required

Is parameter required.

Type

bool

repeated

Deprecated. This field has no effect.

Type

bool

validation_regex

Regular expression which can be used for parameter validation.

Type

str

allowed_values

All possible values for the parameter.

Type

Sequence[str]

min_value

For integer and double values specifies minimum allowed value.

Type

google.protobuf.wrappers_pb2.DoubleValue

max_value

For integer and double values specifies maxminum allowed value.

Type

google.protobuf.wrappers_pb2.DoubleValue

fields

Deprecated. This field has no effect.

Type

Sequence[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

str

validation_help_url

URL to a help document to further explain the naming requirements.

Type

str

immutable

Cannot be changed after initial creation.

Type

bool

recurse

Deprecated. This field has no effect.

Type

bool

deprecated

If true, it should not be used in new transfers, and it should not be visible to users.

Type

bool

class Type(value)[source]

Bases: proto.enums.Enum

Parameter type.

BOOLEAN = 4
DOUBLE = 3
INTEGER = 2
PLUS_PAGE = 6
RECORD = 5
STRING = 1
TYPE_UNSPECIFIED = 0
class google.cloud.bigquery_datatransfer_v1.types.DeleteTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Type

str

class google.cloud.bigquery_datatransfer_v1.types.DeleteTransferRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to delete data transfer run information.

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Type

str

class google.cloud.bigquery_datatransfer_v1.types.EmailPreferences(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents preferences for sending email notifications for transfer run events.

enable_failure_email

If true, email notifications will be sent on transfer run failures.

Type

bool

class google.cloud.bigquery_datatransfer_v1.types.GetDataSourceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to get data source info.

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/dataSources/{data_source_id} or projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}

Type

str

class google.cloud.bigquery_datatransfer_v1.types.GetTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to get data transfer information.

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}

Type

str

class google.cloud.bigquery_datatransfer_v1.types.GetTransferRunRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to get data transfer run information.

name

Required. The field will contain name of the resource requested, for example: projects/{project_id}/transferConfigs/{config_id}/runs/{run_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Type

str

class google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Request 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} or `projects/{project_id}/locations/{location_id}

Type

str

page_token

Pagination token, which can be used to request a specific page of ListDataSourcesRequest list results. For multiple-page results, ListDataSourcesResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Type

str

page_size

Page size. The default page size is the maximum value of 1000 results.

Type

int

class google.cloud.bigquery_datatransfer_v1.types.ListDataSourcesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Returns list of supported data sources and their metadata.

data_sources

List of supported data sources and their transfer settings.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.DataSource]

next_page_token

Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListDataSourcesRequest.page_token to request the next page of list results.

Type

str

property raw_page
class google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to list data transfers configured for a BigQuery project.

parent

Required. The BigQuery project id for which data sources should be returned: projects/{project_id} or projects/{project_id}/locations/{location_id}

Type

str

data_source_ids

When specified, only configurations of requested data sources are returned.

Type

Sequence[str]

page_token

Pagination token, which can be used to request a specific page of ListTransfersRequest list results. For multiple-page results, ListTransfersResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Type

str

page_size

Page size. The default page size is the maximum value of 1000 results.

Type

int

class google.cloud.bigquery_datatransfer_v1.types.ListTransferConfigsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The returned list of pipelines in the project.

transfer_configs

Output only. The stored pipeline transfer configurations.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferConfig]

next_page_token

Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListTransferConfigsRequest.page_token to request the next page of list results.

Type

str

property raw_page
class google.cloud.bigquery_datatransfer_v1.types.ListTransferLogsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A 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} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}

Type

str

page_token

Pagination token, which can be used to request a specific page of ListTransferLogsRequest list results. For multiple-page results, ListTransferLogsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Type

str

page_size

Page size. The default page size is the maximum value of 1000 results.

Type

int

message_types

Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

Type

Sequence[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.Message

The returned list transfer run messages.

transfer_messages

Output only. The stored pipeline transfer messages.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferMessage]

next_page_token

Output only. The next-pagination token. For multiple-page list results, this token can be used as the GetTransferRunLogRequest.page_token to request the next page of list results.

Type

str

property raw_page
class google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

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} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

Type

str

states

When specified, only transfer runs with requested states are returned.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferState]

page_token

Pagination token, which can be used to request a specific page of ListTransferRunsRequest list results. For multiple-page results, ListTransferRunsResponse outputs a next_page token, which can be used as the page_token value to request the next page of list results.

Type

str

page_size

Page size. The default page size is the maximum value of 1000 results.

Type

int

run_attempt

Indicates how run attempts are to be pulled.

Type

google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsRequest.RunAttempt

class RunAttempt(value)[source]

Bases: proto.enums.Enum

Represents which runs should be pulled.

LATEST = 1
RUN_ATTEMPT_UNSPECIFIED = 0
class google.cloud.bigquery_datatransfer_v1.types.ListTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

The returned list of pipelines in the project.

transfer_runs

Output only. The stored pipeline transfer runs.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]

next_page_token

Output only. The next-pagination token. For multiple-page list results, this token can be used as the ListTransferRunsRequest.page_token to request the next page of list results.

Type

str

property raw_page
class google.cloud.bigquery_datatransfer_v1.types.ScheduleOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Options 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

bool

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.

Type

google.protobuf.timestamp_pb2.Timestamp

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.

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to schedule transfer runs for a time range.

parent

Required. Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

Type

str

start_time

Required. Start time of the range of transfer runs. For example, "2017-05-25T00:00:00+00:00".

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Required. End time of the range of transfer runs. For example, "2017-05-30T00:00:00+00:00".

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.bigquery_datatransfer_v1.types.ScheduleTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response to schedule transfer runs for a time range.

runs

The transfer runs that were scheduled.

Type

Sequence[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.Message

A request to start manual transfer runs.

parent

Transfer configuration name in the form: projects/{project_id}/transferConfigs/{config_id} or projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}.

Type

str

requested_time_range

Time range for the transfer runs that should be started.

Type

google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsRequest.TimeRange

requested_run_time

Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.

Type

google.protobuf.timestamp_pb2.Timestamp

class TimeRange(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A 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).

Type

google.protobuf.timestamp_pb2.Timestamp

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).

Type

google.protobuf.timestamp_pb2.Timestamp

class google.cloud.bigquery_datatransfer_v1.types.StartManualTransferRunsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A response to start manual transfer runs.

runs

The transfer runs that were created.

Type

Sequence[google.cloud.bigquery_datatransfer_v1.types.TransferRun]

class google.cloud.bigquery_datatransfer_v1.types.TransferConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

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.

name

The resource name of the transfer config. Transfer config names have the form projects/{project_id}/locations/{region}/transferConfigs/{config_id}. Where config_id is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config.

Type

str

destination_dataset_id

The BigQuery target dataset id.

Type

str

display_name

User specified display name for the data transfer.

Type

str

data_source_id

Data source id. Cannot be changed once data transfer is created.

Type

str

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

Type

google.protobuf.struct_pb2.Struct

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, and first 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_format NOTE: the granularity should be at least 8 hours, or less frequent.

Type

str

schedule_options

Options customizing the data transfer schedule.

Type

google.cloud.bigquery_datatransfer_v1.types.ScheduleOptions

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

int

disabled

Is this config disabled. When set to true, no runs are scheduled for a given transfer.

Type

bool

update_time

Output only. Data transfer modification time. Ignored by server on input.

Type

google.protobuf.timestamp_pb2.Timestamp

next_run_time

Output only. Next time when data transfer will run.

Type

google.protobuf.timestamp_pb2.Timestamp

state

Output only. State of the most recently updated transfer run.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferState

user_id

Deprecated. Unique ID of the user on whose behalf transfer is done.

Type

int

dataset_region

Output only. Region in which BigQuery dataset is located.

Type

str

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}/topics/{topic}

Type

str

email_preferences

Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

Type

google.cloud.bigquery_datatransfer_v1.types.EmailPreferences

class google.cloud.bigquery_datatransfer_v1.types.TransferMessage(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a user facing message for a particular data transfer run.

message_time

Time when message was logged.

Type

google.protobuf.timestamp_pb2.Timestamp

severity

Message severity.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferMessage.MessageSeverity

message_text

Message text.

Type

str

class MessageSeverity(value)[source]

Bases: proto.enums.Enum

Represents data transfer user facing message severity.

ERROR = 3
INFO = 1
MESSAGE_SEVERITY_UNSPECIFIED = 0
WARNING = 2
class google.cloud.bigquery_datatransfer_v1.types.TransferRun(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

Represents a data transfer run.

name

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

str

schedule_time

Minimum time after which a transfer run can be started.

Type

google.protobuf.timestamp_pb2.Timestamp

run_time

For batch transfer runs, specifies the date and time of the data should be ingested.

Type

google.protobuf.timestamp_pb2.Timestamp

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.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Output only. Time when transfer run ended. Parameter ignored by server for input requests.

Type

google.protobuf.timestamp_pb2.Timestamp

update_time

Output only. Last time the data transfer run state was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

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

Type

google.protobuf.struct_pb2.Struct

destination_dataset_id

Output only. The BigQuery target dataset id.

Type

str

data_source_id

Output only. Data source id.

Type

str

state

Data transfer run state. Ignored for input requests.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferState

user_id

Deprecated. Unique ID of the user on whose behalf transfer is done.

Type

int

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_time doesn’t always match this.

Type

str

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}/topics/{topic}

Type

str

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.

Type

google.cloud.bigquery_datatransfer_v1.types.EmailPreferences

class google.cloud.bigquery_datatransfer_v1.types.TransferState(value)[source]

Bases: proto.enums.Enum

Represents data transfer run state.

CANCELLED = 6
FAILED = 5
PENDING = 2
RUNNING = 3
SUCCEEDED = 4
TRANSFER_STATE_UNSPECIFIED = 0
class google.cloud.bigquery_datatransfer_v1.types.TransferType(value)[source]

Bases: proto.enums.Enum

DEPRECATED. Represents data transfer type.

BATCH = 1
STREAMING = 2
TRANSFER_TYPE_UNSPECIFIED = 0
class google.cloud.bigquery_datatransfer_v1.types.UpdateTransferConfigRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]

Bases: proto.message.Message

A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.

transfer_config

Required. Data transfer configuration to create.

Type

google.cloud.bigquery_datatransfer_v1.types.TransferConfig

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=&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

  • client_id should be OAuth client_id of BigQuery DTS API for the given data source returned by ListDataSources method.

  • data_source_scopes are the scopes returned by ListDataSources method.

  • redirect_uri is an optional parameter. If not specified, then authorization code is posted to the opener of authorization flow window. Otherwise it will be sent to the redirect uri. A special value of urn:ietf:wg:oauth:2.0:oob means that authorization code should be returned in the title bar of the browser, with the page text prompting the user to copy the code and paste it in the application.

Type

str

update_mask

Required. Required list of fields to be updated in this request.

Type

google.protobuf.field_mask_pb2.FieldMask

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.

Type

str

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.

Type

str