TransferRun

com.google.cloud.bigquery.datatransfer.v1.transfer.TransferRun
See theTransferRun companion object
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 with Updatable[TransferRun]

Represents a data transfer run.

Attributes

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.

Companion:
object
Source:
TransferRun.scala
Graph
Supertypes
trait Updatable[TransferRun]
trait GeneratedMessage
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

Attributes

Source:
TransferRun.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source:
TransferRun.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source:
TransferRun.scala

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns:

human-readable representation of this message.

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala
def withUnknownFields(`__v`: UnknownFieldSet): TransferRun

Attributes

Source:
TransferRun.scala

Attributes

Source:
TransferRun.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source:
TransferRun.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
def update(ms: Lens[TransferRun, TransferRun] => () => TransferRun*): A

Attributes

Inherited from:
Updatable
Source:
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source:
GeneratedMessageCompanion.scala