Types for BigQuery Data Transfer API Client#
-
class
google.cloud.bigquery_datatransfer_v1.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
BoolValue
# -
value
# Field google.protobuf.BoolValue.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
BytesValue
# -
value
# Field google.protobuf.BytesValue.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
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.
-
name
# The data source in the form:
projects/{project_id}/dataSources/{data_source_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.CheckValidCredsRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
CheckValidCredsResponse
# A response indicating whether the credentials exist and are valid.
-
has_valid_creds
# If set to
true
, the credentials exist and are valid.
-
has_valid_creds
Field google.cloud.bigquery.datatransfer.v1.CheckValidCredsResponse.has_valid_creds
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
CreateTransferConfigRequest
# 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
# The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} If specified location and location of the destination bigquery dataset do not match - the request will fail.
-
transfer_config
# Data transfer configuration to create.
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.gsta tic.com/bigquerydatatransfer/oauthz/auth?client_id=&scope=&re direct_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.
-
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.
-
authorization_code
Field google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.authorization_code
-
parent
Field google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.parent
-
transfer_config
Field google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.transfer_config
-
version_info
Field google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest.version_info
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
DataSource
# Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
-
name
# Output only. Data source resource name.
-
data_source_id
# Data source id.
-
display_name
# User friendly data source name.
-
description
# User friendly data source description string.
-
client_id
# Data source client id which should be used to receive refresh token.
-
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
-
transfer_type
# Deprecated. This field has no effect.
-
supports_multiple_transfers
# 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.
-
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
.
-
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.
-
parameters
# Data source parameters.
-
help_url
# Url for the help document for this data source.
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
.
-
manual_runs_disabled
# Disables backfilling and manual run scheduling for the data source.
-
minimum_schedule_interval
# The minimum interval for scheduler to schedule runs.
-
authorization_type
Field google.cloud.bigquery.datatransfer.v1.DataSource.authorization_type
-
client_id
Field google.cloud.bigquery.datatransfer.v1.DataSource.client_id
-
data_refresh_type
Field google.cloud.bigquery.datatransfer.v1.DataSource.data_refresh_type
-
data_source_id
Field google.cloud.bigquery.datatransfer.v1.DataSource.data_source_id
-
default_data_refresh_window_days
Field google.cloud.bigquery.datatransfer.v1.DataSource.default_data_refresh_window_days
-
default_schedule
Field google.cloud.bigquery.datatransfer.v1.DataSource.default_schedule
-
description
Field google.cloud.bigquery.datatransfer.v1.DataSource.description
-
display_name
Field google.cloud.bigquery.datatransfer.v1.DataSource.display_name
-
help_url
Field google.cloud.bigquery.datatransfer.v1.DataSource.help_url
-
manual_runs_disabled
Field google.cloud.bigquery.datatransfer.v1.DataSource.manual_runs_disabled
-
minimum_schedule_interval
Field google.cloud.bigquery.datatransfer.v1.DataSource.minimum_schedule_interval
-
name
Field google.cloud.bigquery.datatransfer.v1.DataSource.name
-
parameters
Field google.cloud.bigquery.datatransfer.v1.DataSource.parameters
-
scopes
Field google.cloud.bigquery.datatransfer.v1.DataSource.scopes
-
supports_custom_schedule
Field google.cloud.bigquery.datatransfer.v1.DataSource.supports_custom_schedule
-
supports_multiple_transfers
Field google.cloud.bigquery.datatransfer.v1.DataSource.supports_multiple_transfers
-
transfer_type
Field google.cloud.bigquery.datatransfer.v1.DataSource.transfer_type
-
update_deadline_seconds
Field google.cloud.bigquery.datatransfer.v1.DataSource.update_deadline_seconds
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
DataSourceParameter
# 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.
-
display_name
# Parameter display name in the user interface.
-
description
# Parameter description.
-
type
# Parameter type.
-
required
# Is parameter required.
-
repeated
# Deprecated. This field has no effect.
-
validation_regex
# Regular expression which can be used for parameter validation.
-
allowed_values
# All possible values for the parameter.
-
min_value
# For integer and double values specifies minimum allowed value.
-
max_value
# For integer and double values specifies maxminum allowed value.
-
fields
# Deprecated. This field has no effect.
-
validation_description
# Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
-
validation_help_url
# URL to a help document to further explain the naming requirements.
-
immutable
# Cannot be changed after initial creation.
-
recurse
# Deprecated. This field has no effect.
-
deprecated
# If true, it should not be used in new transfers, and it should not be visible to users.
-
allowed_values
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.allowed_values
-
deprecated
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.deprecated
-
description
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.description
-
display_name
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.display_name
-
fields
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.fields
-
immutable
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.immutable
-
max_value
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.max_value
-
min_value
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.min_value
-
param_id
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.param_id
-
recurse
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.recurse
-
repeated
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.repeated
-
required
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.required
-
type
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.type
-
validation_description
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.validation_description
-
validation_help_url
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.validation_help_url
-
validation_regex
Field google.cloud.bigquery.datatransfer.v1.DataSourceParameter.validation_regex
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
DeleteTransferConfigRequest
# A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
-
name
# The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.DeleteTransferConfigRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
DeleteTransferRunRequest
# A request to delete data transfer run information.
-
name
# The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/r uns/{run_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.DeleteTransferRunRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
DoubleValue
# -
value
# Field google.protobuf.DoubleValue.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Duration
# -
nanos
# Field google.protobuf.Duration.nanos
-
seconds
# Field google.protobuf.Duration.seconds
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Empty
#
-
class
google.cloud.bigquery_datatransfer_v1.types.
FieldMask
# -
paths
# Field google.protobuf.FieldMask.paths
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
FloatValue
# -
value
# Field google.protobuf.FloatValue.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
GetDataSourceRequest
# A request to get data source info.
-
name
# The field will contain name of the resource requested, for example:
projects/{project_id}/dataSources/{data_source_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.GetDataSourceRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
GetTransferConfigRequest
# A request to get data transfer information.
-
name
# The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.GetTransferConfigRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
GetTransferRunRequest
# A request to get data transfer run information.
-
name
# The field will contain name of the resource requested, for example:
projects/{project_id}/transferConfigs/{config_id}/r uns/{run_id}
-
name
Field google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest.name
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Int32Value
# -
value
# Field google.protobuf.Int32Value.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Int64Value
# -
value
# Field google.protobuf.Int64Value.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListDataSourcesRequest
# Request to list supported data sources and their data transfer settings.
-
parent
# The BigQuery project id for which data sources should be returned. Must be in the form:
projects/{project_id}
-
page_token
# Pagination token, which can be used to request a specific page of
ListDataSourcesRequest
list results. For multiple-page results,ListDataSourcesResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
-
page_size
# Page size. The default page size is the maximum value of 1000 results.
-
page_size
Field google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest.page_size
-
page_token
Field google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest.page_token
-
parent
Field google.cloud.bigquery.datatransfer.v1.ListDataSourcesRequest.parent
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListDataSourcesResponse
# Returns list of supported data sources and their metadata.
-
data_sources
# List of supported data sources and their transfer settings.
-
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.
-
data_sources
Field google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse.data_sources
-
next_page_token
Field google.cloud.bigquery.datatransfer.v1.ListDataSourcesResponse.next_page_token
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferConfigsRequest
# A request to list data transfers configured for a BigQuery project.
-
parent
# The BigQuery project id for which data sources should be returned:
projects/{project_id}
.
-
data_source_ids
# When specified, only configurations of requested data sources are returned.
-
page_token
# Pagination token, which can be used to request a specific page of
ListTransfersRequest
list results. For multiple-page results,ListTransfersResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
-
page_size
# Page size. The default page size is the maximum value of 1000 results.
-
data_source_ids
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest.data_source_ids
-
page_size
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest.page_size
-
page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest.page_token
-
parent
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsRequest.parent
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferConfigsResponse
# The returned list of pipelines in the project.
-
transfer_configs
# Output only. The stored pipeline transfer configurations.
-
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.
-
next_page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse.next_page_token
-
transfer_configs
Field google.cloud.bigquery.datatransfer.v1.ListTransferConfigsResponse.transfer_configs
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferLogsRequest
# A request to get user facing log messages associated with data transfer run.
-
parent
# Transfer run name in the form:
projects/{project_id}/transfe rConfigs/{config_Id}/runs/{run_id}
.
-
page_token
# Pagination token, which can be used to request a specific page of
ListTransferLogsRequest
list results. For multiple-page results,ListTransferLogsResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
-
page_size
# Page size. The default page size is the maximum value of 1000 results.
-
message_types
# Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
-
message_types
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest.message_types
-
page_size
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest.page_size
-
page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest.page_token
-
parent
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsRequest.parent
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferLogsResponse
# The returned list transfer run messages.
-
transfer_messages
# Output only. The stored pipeline transfer messages.
-
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.
-
next_page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse.next_page_token
-
transfer_messages
Field google.cloud.bigquery.datatransfer.v1.ListTransferLogsResponse.transfer_messages
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferRunsRequest
# 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
# Name of transfer configuration for which transfer runs should be retrieved. Format of transfer configuration resource name is:
projects/{project_id}/transferConfigs/{config_id}
.
-
states
# When specified, only transfer runs with requested states are returned.
-
page_token
# Pagination token, which can be used to request a specific page of
ListTransferRunsRequest
list results. For multiple-page results,ListTransferRunsResponse
outputs anext_page
token, which can be used as thepage_token
value to request the next page of list results.
-
page_size
# Page size. The default page size is the maximum value of 1000 results.
-
run_attempt
# Indicates how run attempts are to be pulled.
-
page_size
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.page_size
-
page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.page_token
-
parent
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.parent
-
run_attempt
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.run_attempt
-
states
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsRequest.states
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListTransferRunsResponse
# The returned list of pipelines in the project.
-
transfer_runs
# Output only. The stored pipeline transfer runs.
-
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.
-
next_page_token
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse.next_page_token
-
transfer_runs
Field google.cloud.bigquery.datatransfer.v1.ListTransferRunsResponse.transfer_runs
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ListValue
# -
values
# Field google.protobuf.ListValue.values
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ScheduleOptions
# 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.
-
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.
-
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.
-
disable_auto_scheduling
Field google.cloud.bigquery.datatransfer.v1.ScheduleOptions.disable_auto_scheduling
-
end_time
Field google.cloud.bigquery.datatransfer.v1.ScheduleOptions.end_time
-
start_time
Field google.cloud.bigquery.datatransfer.v1.ScheduleOptions.start_time
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ScheduleTransferRunsRequest
# A request to schedule transfer runs for a time range.
-
parent
# Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}
.
-
start_time
# Start time of the range of transfer runs. For example,
"2017-05-25T00:00:00+00:00"
.
-
end_time
# End time of the range of transfer runs. For example,
"2017-05-30T00:00:00+00:00"
.
-
end_time
Field google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest.end_time
-
parent
Field google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest.parent
-
start_time
Field google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsRequest.start_time
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
ScheduleTransferRunsResponse
# A response to schedule transfer runs for a time range.
-
runs
# The transfer runs that were scheduled.
-
runs
Field google.cloud.bigquery.datatransfer.v1.ScheduleTransferRunsResponse.runs
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
StartManualTransferRunsRequest
# A request to start manual transfer runs.
-
parent
# Transfer configuration name in the form:
projects/{project_id}/transferConfigs/{config_id}
.
-
time
# The requested time specification - this can be a time range or a specific run_time.
-
requested_time_range
# Time range for the transfer runs that should be started.
-
requested_run_time
# Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
-
class
TimeRange
# 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 betwen start_time (inclusive) and end_time (exlusive).
-
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 betwen start_time (inclusive) and end_time (exlusive).
-
end_time
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange.end_time
-
start_time
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.TimeRange.start_time
-
-
parent
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.parent
-
requested_run_time
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.requested_run_time
-
requested_time_range
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsRequest.requested_time_range
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
StartManualTransferRunsResponse
# A response to start manual transfer runs.
-
runs
# The transfer runs that were created.
-
runs
Field google.cloud.bigquery.datatransfer.v1.StartManualTransferRunsResponse.runs
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
StringValue
# -
value
# Field google.protobuf.StringValue.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Struct
# -
class
FieldsEntry
# -
key
# Field google.protobuf.Struct.FieldsEntry.key
-
value
# Field google.protobuf.Struct.FieldsEntry.value
-
-
fields
# Field google.protobuf.Struct.fields
-
class
-
class
google.cloud.bigquery_datatransfer_v1.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
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 specifieddestination_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 of
projects/{project_id}/locations/{regi on}/transferConfigs/{config_id}
. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id.
-
destination_dataset_id
# The BigQuery target dataset id.
-
display_name
# User specified display name for the data transfer.
-
data_source_id
# Data source id. Cannot be changed once data transfer is created.
-
params
# Data transfer specific parameters.
-
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/flexi ble/python/scheduling-jobs-with-cron- yaml#the_schedule_format NOTE: the granularity should be at least 8 hours, or less frequent.
-
schedule_options
# Options customizing the data transfer 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.
-
disabled
# Is this config disabled. When set to true, no runs are scheduled for a given transfer.
-
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.
-
user_id
# Deprecated. Unique ID of the user on whose behalf transfer is done.
-
dataset_region
# Output only. Region in which BigQuery dataset is located.
-
data_refresh_window_days
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.data_refresh_window_days
-
data_source_id
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.data_source_id
-
dataset_region
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.dataset_region
-
destination_dataset_id
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.destination_dataset_id
-
disabled
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.disabled
-
display_name
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.display_name
-
name
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.name
-
next_run_time
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.next_run_time
-
params
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.params
-
schedule
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.schedule
-
schedule_options
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.schedule_options
-
state
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.state
-
update_time
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.update_time
-
user_id
Field google.cloud.bigquery.datatransfer.v1.TransferConfig.user_id
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
TransferMessage
# Represents a user facing message for a particular data transfer run.
-
message_time
# Time when message was logged.
-
severity
# Message severity.
-
message_text
# Message text.
-
message_text
Field google.cloud.bigquery.datatransfer.v1.TransferMessage.message_text
-
message_time
Field google.cloud.bigquery.datatransfer.v1.TransferMessage.message_time
-
severity
Field google.cloud.bigquery.datatransfer.v1.TransferMessage.severity
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
TransferRun
# Represents a data transfer run.
-
name
# The resource name of the transfer run. Transfer run names have the form
projects/{project_id}/locations/{location}/transfer Configs/{config_id}/runs/{run_id}
. The name is ignored when creating a transfer run.
-
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.
-
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. Data transfer specific parameters.
-
destination_dataset_id
# Output only. The BigQuery target dataset id.
-
data_source_id
# Output only. Data source id.
-
state
# Data transfer run state. Ignored for input requests.
-
user_id
# Deprecated. Unique ID of the user on whose behalf transfer is done.
-
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.
-
data_source_id
Field google.cloud.bigquery.datatransfer.v1.TransferRun.data_source_id
-
destination_dataset_id
Field google.cloud.bigquery.datatransfer.v1.TransferRun.destination_dataset_id
-
end_time
Field google.cloud.bigquery.datatransfer.v1.TransferRun.end_time
-
error_status
Field google.cloud.bigquery.datatransfer.v1.TransferRun.error_status
-
name
Field google.cloud.bigquery.datatransfer.v1.TransferRun.name
-
params
Field google.cloud.bigquery.datatransfer.v1.TransferRun.params
-
run_time
Field google.cloud.bigquery.datatransfer.v1.TransferRun.run_time
-
schedule
Field google.cloud.bigquery.datatransfer.v1.TransferRun.schedule
-
schedule_time
Field google.cloud.bigquery.datatransfer.v1.TransferRun.schedule_time
-
start_time
Field google.cloud.bigquery.datatransfer.v1.TransferRun.start_time
-
state
Field google.cloud.bigquery.datatransfer.v1.TransferRun.state
-
update_time
Field google.cloud.bigquery.datatransfer.v1.TransferRun.update_time
-
user_id
Field google.cloud.bigquery.datatransfer.v1.TransferRun.user_id
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
UInt32Value
# -
value
# Field google.protobuf.UInt32Value.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
UInt64Value
# -
value
# Field google.protobuf.UInt64Value.value
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
UpdateTransferConfigRequest
# 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
# Data transfer configuration to create.
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://w ww.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&sc ope=&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.
-
update_mask
# Required list of fields to be updated in this request.
-
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.
-
authorization_code
Field google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code
-
transfer_config
Field google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.transfer_config
-
update_mask
Field google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.update_mask
-
version_info
Field google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.version_info
-
-
class
google.cloud.bigquery_datatransfer_v1.types.
Value
# -
bool_value
# Field google.protobuf.Value.bool_value
-
list_value
# Field google.protobuf.Value.list_value
-
null_value
# Field google.protobuf.Value.null_value
-
number_value
# Field google.protobuf.Value.number_value
-
string_value
# Field google.protobuf.Value.string_value
-
struct_value
# Field google.protobuf.Value.struct_value
-