Google BigQuery Data Transfer v1 API - Class TransferRun (4.3.0)

public sealed class TransferRun : IMessage<TransferRun>, IEquatable<TransferRun>, IDeepCloneable<TransferRun>, IBufferMessage, IMessage

Reference documentation and code samples for the Google BigQuery Data Transfer v1 API class TransferRun.

Represents a data transfer run.

Inheritance

Object > TransferRun

Implements

IMessage<TransferRun>, IEquatable<TransferRun>, IDeepCloneable<TransferRun>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

TransferRun()

public TransferRun()

TransferRun(TransferRun)

public TransferRun(TransferRun other)

Parameter
Name	Description
`other`	`TransferRun`

Properties

DataSourceId

public string DataSourceId { get; set; }

Output only. Data source id.

Property Value
Type	Description
`String`

DestinationCase

public TransferRun.DestinationOneofCase DestinationCase { get; }

Property Value
Type	Description
`TransferRun.DestinationOneofCase`

DestinationDatasetId

public string DestinationDatasetId { get; set; }

Output only. The BigQuery target dataset id.

Property Value
Type	Description
`String`

EmailPreferences

public EmailPreferences EmailPreferences { get; set; }

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.

Property Value
Type	Description
`EmailPreferences`

EndTime

public Timestamp EndTime { get; set; }

Output only. Time when transfer run ended. Parameter ignored by server for input requests.

Property Value
Type	Description
`Timestamp`

ErrorStatus

public Status ErrorStatus { get; set; }

Status of the transfer run.

Property Value
Type	Description
`Status`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`String`

NotificationPubsubTopic

public string NotificationPubsubTopic { get; set; }

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}

Property Value
Type	Description
`String`

Params

public Struct Params { get; set; }

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

Property Value
Type	Description
`Struct`

RunName

public RunName RunName { get; set; }

RunName-typed view over the Name resource name property.

Property Value
Type	Description
`RunName`

RunTime

public Timestamp RunTime { get; set; }

For batch transfer runs, specifies the date and time of the data should be ingested.

Property Value
Type	Description
`Timestamp`

Schedule

public string Schedule { get; set; }

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.

Property Value
Type	Description
`String`

ScheduleTime

public Timestamp ScheduleTime { get; set; }

Minimum time after which a transfer run can be started.

Property Value
Type	Description
`Timestamp`

StartTime

public Timestamp StartTime { get; set; }

Output only. Time when transfer run was started. Parameter ignored by server for input requests.

Property Value
Type	Description
`Timestamp`

State

public TransferState State { get; set; }

Data transfer run state. Ignored for input requests.

Property Value
Type	Description
`TransferState`

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Last time the data transfer run state was updated.

Property Value
Type	Description
`Timestamp`

UserId

public long UserId { get; set; }

Deprecated. Unique ID of the user on whose behalf transfer is done.

Property Value
Type	Description
`Int64`