com.google.cloud.bigquery.datatransfer.v1.transfer

Represents preferences for sending email notifications for transfer run events.

Value parameters

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

Attributes

Companion: object
Source: EmailPreferences.scala
Supertypes: trait Updatable[EmailPreferences]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: EmailPreferences.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[EmailPreferences]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: EmailPreferences.type

Represents the encryption configuration for a transfer.

Value parameters

kmsKeyName: The name of the KMS key used for encrypting BigQuery data.

Attributes

Companion: object
Source: EncryptionConfiguration.scala
Supertypes: trait Updatable[EncryptionConfiguration]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: EncryptionConfiguration.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[EncryptionConfiguration]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: EncryptionConfiguration.type

Options customizing the data transfer schedule.

Value parameters

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.

Attributes

Companion: object
Source: ScheduleOptions.scala
Supertypes: trait Updatable[ScheduleOptions]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ScheduleOptions.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[ScheduleOptions]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: ScheduleOptions.type

final case class TransferConfig(name: String, destination: Destination, displayName: String, dataSourceId: String, params: Option[Struct], schedule: String, scheduleOptions: Option[ScheduleOptions], dataRefreshWindowDays: Int, disabled: Boolean, updateTime: Option[Timestamp], nextRunTime: Option[Timestamp], state: TransferState, userId: Long, datasetRegion: String, notificationPubsubTopic: String, emailPreferences: Option[EmailPreferences], ownerInfo: Option[UserInfo], encryptionConfiguration: Option[EncryptionConfiguration], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[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.

Value parameters

dataRefreshWindowDays: 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.
dataSourceId: 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
datasetRegion: Output only. Region in which BigQuery dataset is located.
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.
encryptionConfiguration: 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.
name: 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.
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: projects/{project}/topics/{topic}
ownerInfo: 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.
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: 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.
scheduleOptions: Options customizing the data transfer schedule.
state: Output only. State of the most recently updated transfer run.
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.

Attributes

Companion: object
Source: TransferConfig.scala
Supertypes: trait Updatable[TransferConfig]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: TransferConfig.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[TransferConfig]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: TransferConfig.type

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

Value parameters

messageText: Message text.
messageTime: Time when message was logged.
severity: Message severity.

Attributes

Companion: object
Source: TransferMessage.scala
Supertypes: trait Updatable[TransferMessage]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: TransferMessage.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[TransferMessage]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: TransferMessage.type

Attributes

Source: TransferProto.scala
Supertypes: class GeneratedFileObject

class Object

trait Matchable

class Any
Self type: TransferProto.type

final case class TransferRun(name: String, scheduleTime: Option[Timestamp], runTime: Option[Timestamp], errorStatus: Option[Status], startTime: Option[Timestamp], endTime: Option[Timestamp], updateTime: Option[Timestamp], params: Option[Struct], destination: Destination, dataSourceId: String, state: TransferState, userId: Long, schedule: String, notificationPubsubTopic: String, emailPreferences: Option[EmailPreferences], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[TransferRun]

Represents a data transfer run.

Value parameters

dataSourceId: Output only. Data source 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 projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}. The name is ignored when creating a transfer run.
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: projects/{project}/topics/{topic}
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 schedule_time doesn't always match this.
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.
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.

Attributes

Companion: object
Source: TransferRun.scala
Supertypes: trait Updatable[TransferRun]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: TransferRun.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[TransferRun]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: TransferRun.type

Represents data transfer run state.

Attributes

Companion: object
Source: TransferState.scala
Supertypes: trait GeneratedEnum

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: object CANCELLED.type

object FAILED.type

object PENDING.type

object RUNNING.type

trait Recognized

object SUCCEEDED.type

object TRANSFER_STATE_UNSPECIFIED.type

class Unrecognized
Show all

Attributes

Companion: class
Source: TransferState.scala
Supertypes: trait Sum

trait Mirror

trait GeneratedEnumCompanion[TransferState]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: TransferState.type

Information about a user.

Value parameters

email: E-mail address of the user.

Attributes

Companion: object
Source: UserInfo.scala
Supertypes: trait Updatable[UserInfo]

trait GeneratedMessage

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: UserInfo.scala
Supertypes: trait Product

trait Mirror

trait GeneratedMessageCompanion[UserInfo]

trait Serializable

class Object

trait Matchable

class Any
Show all
Self type: UserInfo.type

com.google.cloud.bigquery.datatransfer.v1.transfer

Members list

Type members

Classlikes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Deprecated classlikes

Attributes

Attributes