API documentation for bigquery_datatransfer_v1.types module.
Classes
Any
API documentation for bigquery_datatransfer_v1.types.Any class.
BoolValue
API documentation for bigquery_datatransfer_v1.types.BoolValue class.
BytesValue
API documentation for bigquery_datatransfer_v1.types.BytesValue class.
CheckValidCredsRequest
A request to determine whether the user has valid credentials. This method is used to limit the number of OAuth popups in the user interface. The user id is inferred from the API call context. If the data source has the Google+ authorization type, this method returns false, as it cannot be determined whether the credentials are already valid merely based on the user id.
CheckValidCredsResponse
A response indicating whether the credentials exist and are valid.
CreateTransferConfigRequest
A request to create a data transfer configuration. If new credentials are needed for this transfer configuration, 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.
Required. Data transfer configuration to create.
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.
DataSource
Represents data source metadata. Metadata is sufficient to render UI and request proper OAuth tokens.
Data source id.
User friendly data source description string.
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
Deprecated. This field has no effect.
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.
Data source parameters.
Indicates the type of authorization.
Default data refresh window on days. Only meaningful when
data_refresh_type = SLIDING_WINDOW.
The minimum interval for scheduler to schedule runs.
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.
Parameter display name in the user interface.
Parameter type.
Deprecated. This field has no effect.
All possible values for the parameter.
For integer and double values specifies maxminum allowed value.
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
Cannot be changed after initial creation.
If true, it should not be used in new transfers, and it should not be visible to users.
DeleteTransferConfigRequest
A request to delete data transfer information. All associated transfer runs and log messages will be deleted as well.
DeleteTransferRunRequest
A request to delete data transfer run information.
DoubleValue
API documentation for bigquery_datatransfer_v1.types.DoubleValue class.
Duration
API documentation for bigquery_datatransfer_v1.types.Duration class.
EmailPreferences
Represents preferences for sending email notifications for transfer run events.
Empty
API documentation for bigquery_datatransfer_v1.types.Empty class.
FieldMask
API documentation for bigquery_datatransfer_v1.types.FieldMask class.
FloatValue
API documentation for bigquery_datatransfer_v1.types.FloatValue class.
GetDataSourceRequest
A request to get data source info.
GetTransferConfigRequest
A request to get data transfer information.
GetTransferRunRequest
A request to get data transfer run information.
Int32Value
API documentation for bigquery_datatransfer_v1.types.Int32Value class.
Int64Value
API documentation for bigquery_datatransfer_v1.types.Int64Value class.
ListDataSourcesRequest
Request to list supported data sources and their data transfer settings.
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.
ListDataSourcesResponse
Returns list of supported data sources and their metadata.
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.
ListTransferConfigsRequest
A request to list data transfers configured for a BigQuery project.
When specified, only configurations of requested data sources are returned.
Page size. The default page size is the maximum value of 1000 results.
ListTransferConfigsResponse
The returned list of pipelines in the project.
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.
ListTransferLogsRequest
A request to get user facing log messages associated with data transfer run.
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.
Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.
ListTransferLogsResponse
The returned list transfer run messages.
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.
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.
When specified, only transfer runs with requested states are returned.
Page size. The default page size is the maximum value of 1000 results.
ListTransferRunsResponse
The returned list of pipelines in the project.
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.
ListValue
API documentation for bigquery_datatransfer_v1.types.ListValue class.
ScheduleOptions
Options customizing the data transfer schedule.
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.
ScheduleTransferRunsRequest
A request to schedule transfer runs for a time range.
Required. Start time of the range of transfer runs. For
example, "2017-05-25T00:00:00+00:00".
ScheduleTransferRunsResponse
A response to schedule transfer runs for a time range.
StartManualTransferRunsRequest
A request to start manual transfer runs.
The requested time specification - this can be a time range or a specific run_time.
Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
StartManualTransferRunsResponse
A response to start manual transfer runs.
Status
API documentation for bigquery_datatransfer_v1.types.Status class.
StringValue
API documentation for bigquery_datatransfer_v1.types.StringValue class.
Struct
API documentation for bigquery_datatransfer_v1.types.Struct class.
Timestamp
API documentation for bigquery_datatransfer_v1.types.Timestamp class.
TransferConfig
Represents a data transfer configuration. A transfer configuration
contains all metadata needed to perform a data transfer. For example,
destination_dataset_id specifies where data should be stored. When
a new transfer configuration is created, the specified
destination_dataset_id is created when needed and shared with the
appropriate data source service account.
The desination of the transfer config.
User specified display name for the data transfer.
Data transfer specific parameters.
Options customizing the data transfer schedule.
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
Output only. Next time when data transfer will run.
Deprecated. Unique ID of the user on whose behalf transfer is done.
Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish.
TransferMessage
Represents a user facing message for a particular data transfer run.
Message severity.
TransferRun
Represents a data transfer run.
Minimum time after which a transfer run can be started.
Status of the transfer run.
Output only. Time when transfer run ended. Parameter ignored by server for input requests.
Output only. Data transfer specific parameters.
Output only. The BigQuery target dataset id.
Data transfer run state. Ignored for input requests.
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.
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.
UInt32Value
API documentation for bigquery_datatransfer_v1.types.UInt32Value class.
UInt64Value
API documentation for bigquery_datatransfer_v1.types.UInt64Value class.
UpdateTransferConfigRequest
A request to update a transfer configuration. To update the user id of the transfer configuration, an authorization code needs to be provided.
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://ww w.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=&scop e=&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.
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.
Value
API documentation for bigquery_datatransfer_v1.types.Value class.