CheckValidCredsResponse
A response indicating whether the credentials exist and are valid.Fields | |
---|---|
hasValidCreds |
If set to
|
DataSource
Defines the properties and custom parameters for a data source.Fields | |
---|---|
authorizationType |
Indicates the type of authorization.
|
Enum type. Can be one of the following: | |
AUTHORIZATION_TYPE_UNSPECIFIED |
Type unspecified. |
AUTHORIZATION_CODE |
Use OAuth 2 authorization codes that can be exchanged for a refresh token on the backend. |
GOOGLE_PLUS_AUTHORIZATION_CODE |
Return an authorization code for a given Google+ page that can then be exchanged for a refresh token on the backend. |
FIRST_PARTY_OAUTH |
Use First Party OAuth. |
clientId |
Data source client id which should be used to receive refresh token.
|
dataRefreshType |
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.
|
Enum type. Can be one of the following: | |
DATA_REFRESH_TYPE_UNSPECIFIED |
The data source won't support data auto refresh, which is default value. |
SLIDING_WINDOW |
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 |
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. |
dataSourceId |
Data source id.
|
defaultDataRefreshWindowDays |
Default data refresh window on days. Only meaningful when
|
defaultSchedule |
Default data transfer schedule. Examples of valid schedules include:
|
description |
User friendly data source description string.
|
displayName |
User friendly data source name.
|
helpUrl |
Url for the help document for this data source.
|
manualRunsDisabled |
Disables backfilling and manual run scheduling for the data source.
|
minimumScheduleInterval |
The minimum interval for scheduler to schedule runs.
|
name |
Output only. Data source resource name.
|
parameters[] |
Data source parameters.
|
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
|
supportsCustomSchedule |
Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to
|
supportsMultipleTransfers |
Deprecated. This field has no effect.
|
transferType |
Deprecated. This field has no effect.
|
Enum type. Can be one of the following: | |
TRANSFER_TYPE_UNSPECIFIED |
Invalid or Unknown transfer type placeholder. |
BATCH |
Batch data transfer. |
STREAMING |
Streaming data transfer. Streaming data source currently doesn't support multiple transfer configs per project. |
updateDeadlineSeconds |
The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED.
|
DataSourceParameter
A parameter used to define custom fields in a data source definition.Fields | |
---|---|
allowedValues[] |
All possible values for the parameter.
|
deprecated |
If true, it should not be used in new transfers, and it should not be visible to users.
|
description |
Parameter description.
|
displayName |
Parameter display name in the user interface.
|
fields[] |
Deprecated. This field has no effect.
|
immutable |
Cannot be changed after initial creation.
|
maxValue |
For integer and double values specifies maxminum allowed value.
|
minValue |
For integer and double values specifies minimum allowed value.
|
paramId |
Parameter identifier.
|
recurse |
Deprecated. This field has no effect.
|
repeated |
Deprecated. This field has no effect.
|
required |
Is parameter required.
|
type |
Parameter type.
|
Enum type. Can be one of the following: | |
TYPE_UNSPECIFIED |
Type unspecified. |
STRING |
String parameter. |
INTEGER |
Integer parameter (64-bits). Will be serialized to json as string. |
DOUBLE |
Double precision floating point parameter. |
BOOLEAN |
Boolean parameter. |
RECORD |
Deprecated. This field has no effect. |
PLUS_PAGE |
Page ID for a Google+ Page. |
validationDescription |
Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
|
validationHelpUrl |
URL to a help document to further explain the naming requirements.
|
validationRegex |
Regular expression which can be used for parameter validation.
|
EmailPreferences
Represents preferences for sending email notifications for transfer run events.Fields | |
---|---|
enableFailureEmail |
If true, email notifications will be sent on transfer run failures.
|
EnrollDataSourcesRequest
A request to enroll a set of data sources so they are visible in the BigQuery UI'sTransfer
tab.
Fields | |
---|---|
dataSourceIds[] |
Data sources that are enrolled. It is required to provide at least one data source id.
|
ListDataSourcesResponse
Returns list of supported data sources and their metadata.Fields | |
---|---|
dataSources[] |
List of supported data sources and their transfer settings.
|
nextPageToken |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the
|
ListLocationsResponse
The response message for Locations.ListLocations.Fields | |
---|---|
locations[] |
A list of locations that matches the specified filter in the request.
|
nextPageToken |
The standard List next-page token.
|
ListTransferConfigsResponse
The returned list of pipelines in the project.Fields | |
---|---|
nextPageToken |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the
|
transferConfigs[] |
Output only. The stored pipeline transfer configurations.
|
ListTransferLogsResponse
The returned list transfer run messages.Fields | |
---|---|
nextPageToken |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the
|
transferMessages[] |
Output only. The stored pipeline transfer messages.
|
ListTransferRunsResponse
The returned list of pipelines in the project.Fields | |
---|---|
nextPageToken |
Output only. The next-pagination token. For multiple-page list results, this token can be used as the
|
transferRuns[] |
Output only. The stored pipeline transfer runs.
|
Location
A resource that represents Google Cloud Platform location.Fields | |
---|---|
displayName |
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
labels |
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
|
locationId |
The canonical id for this location. For example:
|
metadata |
Service-specific metadata. For example the available capacity at the given location.
|
name |
Resource name for the location, which may vary between implementations. For example:
|
ScheduleOptions
Options customizing the data transfer schedule.Fields | |
---|---|
disableAutoScheduling |
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.
|
endTime |
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.
|
startTime |
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.Fields | |
---|---|
endTime |
Required. End time of the range of transfer runs. For example,
|
startTime |
Required. Start time of the range of transfer runs. For example,
|
ScheduleTransferRunsResponse
A response to schedule transfer runs for a time range.Fields | |
---|---|
runs[] |
The transfer runs that were scheduled.
|
StartManualTransferRunsRequest
A request to start manual transfer runs.Fields | |
---|---|
requestedRunTime |
Specific run_time for a transfer run to be started. The requested_run_time must not be in the future.
|
requestedTimeRange |
Time range for the transfer runs that should be started.
|
StartManualTransferRunsResponse
A response to start manual transfer runs.Fields | |
---|---|
runs[] |
The transfer runs that were created.
|
Status
TheStatus
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status
message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Fields | |
---|---|
code |
The status code, which should be an enum value of google.rpc.Code.
|
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
|
TimeRange
A specification for a time range, this will request transfer runs with run_time between start_time (inclusive) and end_time (exclusive).Fields | |
---|---|
endTime |
End time of the range of transfer runs. For example,
|
startTime |
Start time of the range of transfer runs. For example,
|
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.
Fields | |
---|---|
dataRefreshWindowDays |
The number of days to look back to automatically refresh the data. For example, if
|
dataSourceId |
Data source id. Cannot be changed once data transfer is created.
|
datasetRegion |
Output only. Region in which BigQuery dataset is located.
|
destinationDatasetId |
The BigQuery target dataset id.
|
disabled |
Is this config disabled. When set to true, no runs are scheduled for a given transfer.
|
displayName |
User specified display name for the data transfer.
|
emailPreferences |
Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.
|
name |
The resource name of the transfer config. Transfer config names have the form
|
nextRunTime |
Output only. Next time when data transfer will run.
|
notificationPubsubTopic |
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:
|
ownerInfo |
Output only. Information about the user whose credentials are used to transfer data. Populated only for
|
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:
|
scheduleOptions |
Options customizing the data transfer schedule.
|
state |
Output only. State of the most recently updated transfer run.
|
Enum type. Can be one of the following: | |
TRANSFER_STATE_UNSPECIFIED |
State placeholder (0). |
PENDING |
Data transfer is scheduled and is waiting to be picked up by data transfer backend (2). |
RUNNING |
Data transfer is in progress (3). |
SUCCEEDED |
Data transfer completed successfully (4). |
FAILED |
Data transfer failed (5). |
CANCELLED |
Data transfer is cancelled (6). |
updateTime |
Output only. Data transfer modification time. Ignored by server on input.
|
userId |
Deprecated. Unique ID of the user on whose behalf transfer is done.
|
TransferMessage
Represents a user facing message for a particular data transfer run.Fields | |
---|---|
messageText |
Message text.
|
messageTime |
Time when message was logged.
|
severity |
Message severity.
|
Enum type. Can be one of the following: | |
MESSAGE_SEVERITY_UNSPECIFIED |
No severity specified. |
INFO |
Informational message. |
WARNING |
Warning message. |
ERROR |
Error message. |
TransferRun
Represents a data transfer run.Fields | |
---|---|
dataSourceId |
Output only. Data source id.
|
destinationDatasetId |
Output only. The BigQuery target dataset id.
|
emailPreferences |
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.
|
endTime |
Output only. Time when transfer run ended. Parameter ignored by server for input requests.
|
errorStatus |
Status of the transfer run.
|
name |
The resource name of the transfer run. Transfer run names have the form
|
notificationPubsubTopic |
Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is:
|
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
|
runTime |
For batch transfer runs, specifies the date and time of the data should be ingested.
|
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
|
scheduleTime |
Minimum time after which a transfer run can be started.
|
startTime |
Output only. Time when transfer run was started. Parameter ignored by server for input requests.
|
state |
Data transfer run state. Ignored for input requests.
|
Enum type. Can be one of the following: | |
TRANSFER_STATE_UNSPECIFIED |
State placeholder (0). |
PENDING |
Data transfer is scheduled and is waiting to be picked up by data transfer backend (2). |
RUNNING |
Data transfer is in progress (3). |
SUCCEEDED |
Data transfer completed successfully (4). |
FAILED |
Data transfer failed (5). |
CANCELLED |
Data transfer is cancelled (6). |
updateTime |
Output only. Last time the data transfer run state was updated.
|
userId |
Deprecated. Unique ID of the user on whose behalf transfer is done.
|
UserInfo
Information about a user.Fields | |
---|---|
email |
E-mail address of the user.
|