gcp_bigquerydatatransfer_transfer_config

ancestors

Type: UNORDERED_LIST_STRING

data_refresh_window_days

Type: INT32
Provider name: dataRefreshWindowDays
Description: 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.

data_source_id

Type: STRING
Provider name: dataSourceId
Description: Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list

dataset_region

Type: STRING
Provider name: datasetRegion
Description: Output only. Region in which BigQuery dataset is located.

destination_dataset_id

Type: STRING
Provider name: destinationDatasetId
Description: The BigQuery target dataset id.

disabled

Type: BOOLEAN
Provider name: disabled
Description: Is this config disabled. When set to true, no runs will be scheduled for this transfer config.

email_preferences

Type: STRUCT
Provider name: emailPreferences
Description: Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config.

• enable_failure_email
  Type: BOOLEAN
  Provider name: enableFailureEmail
  Description: If true, email notifications will be sent on transfer run failures.
  

encryption_configuration

Type: STRUCT
Provider name: encryptionConfiguration
Description: The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent.

• kms_key_name
  Type: STRING
  Provider name: kmsKeyName
  Description: The name of the KMS key used for encrypting BigQuery data.
  

error

Type: STRUCT
Provider name: error
Description: Output only. Error code with detailed information about reason of the latest config failure.

• code
  Type: INT32
  Provider name: code
  Description: The status code, which should be an enum value of google.rpc.Code.
  
• message
  Type: STRING
  Provider name: message
  Description: 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.
  

gcp_display_name

Type: STRING
Provider name: displayName
Description: User specified display name for the data transfer.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: Identifier. The resource name of the transfer config. Transfer config names have the form either projects/{project_id}/locations/{region}/transferConfigs/{config_id} or projects/{project_id}/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.

next_run_time

Type: TIMESTAMP
Provider name: nextRunTime
Description: Output only. Next time when data transfer will run.

notification_pubsub_topic

Type: STRING
Provider name: notificationPubsubTopic
Description: Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: projects/{project_id}/topics/{topic_id}

organization_id

Type: STRING

owner_info

Type: STRUCT
Provider name: ownerInfo
Description: Output only. Information about the user whose credentials are used to transfer data. Populated only for transferConfigs.get requests. In case the user information is not available, this field will not be populated.

• email
  Type: STRING
  Provider name: email
  Description: E-mail address of the user.
  

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

resource_name

Type: STRING

schedule

Type: STRING
Provider name: schedule
Description: 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

schedule_options

Type: STRUCT
Provider name: scheduleOptions
Description: Options customizing the data transfer schedule.

• disable_auto_scheduling
  Type: BOOLEAN
  Provider name: disableAutoScheduling
  Description: 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.
  
• end_time
  Type: TIMESTAMP
  Provider name: endTime
  Description: Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
  
• start_time
  Type: TIMESTAMP
  Provider name: startTime
  Description: Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.
  

schedule_options_v2

Type: STRUCT
Provider name: scheduleOptionsV2
Description: Options customizing different types of data transfer schedule. This field replaces “schedule” and “schedule_options” fields. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

• event_driven_schedule
  Type: STRUCT
  Provider name: eventDrivenSchedule
  Description: Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.
  

  • pubsub_subscription
    Type: STRING
    Provider name: pubsubSubscription
    Description: Pub/Sub subscription name used to receive events. Only Google Cloud Storage data source support this option. Format: projects/{project}/subscriptions/{subscription}
    

• manual_schedule
  Type: STRUCT
  Provider name: manualSchedule
  Description: Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.
  

• time_based_schedule
  Type: STRUCT
  Provider name: timeBasedSchedule
  Description: Time based transfer schedule options. This is the default schedule option.
  

  • end_time
    Type: TIMESTAMP
    Provider name: endTime
    Description: 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.
    
  • schedule
    Type: STRING
    Provider name: schedule
    Description: 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 minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.
    
  • start_time
    Type: TIMESTAMP
    Provider name: startTime
    Description: 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.
    

state

Type: STRING
Provider name: state
Description: Output only. State of the most recently updated transfer run.
Possible values:

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

tags

Type: UNORDERED_LIST_STRING

update_time

Type: TIMESTAMP
Provider name: updateTime
Description: Output only. Data transfer modification time. Ignored by server on input.

user_id

Type: INT64
Provider name: userId
Description: Deprecated. Unique ID of the user on whose behalf transfer is done.