Show / Hide Table of Contents

Class TransferRun

Represents a data transfer run.

Inheritance
object
TransferRun
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.BigQueryDataTransfer.v1.Data
Assembly: Google.Apis.BigQueryDataTransfer.v1.dll
Syntax
public class TransferRun : IDirectResponseSchema

Properties

DataSourceId

Output only. Data source id.

Declaration
[JsonProperty("dataSourceId")]
public virtual string DataSourceId { get; set; }
Property Value
Type Description
string

DestinationDatasetId

Output only. The BigQuery target dataset id.

Declaration
[JsonProperty("destinationDatasetId")]
public virtual string DestinationDatasetId { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("emailPreferences")]
public virtual EmailPreferences EmailPreferences { get; set; }
Property Value
Type Description
EmailPreferences

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

ErrorStatus

Status of the transfer run.

Declaration
[JsonProperty("errorStatus")]
public virtual Status ErrorStatus { get; set; }
Property Value
Type Description
Status

Name

Identifier. 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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

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_id}/topics/{topic_id}

Declaration
[JsonProperty("notificationPubsubTopic")]
public virtual string NotificationPubsubTopic { get; set; }
Property Value
Type Description
string

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

Declaration
[JsonProperty("params")]
public virtual IDictionary<string, object> Params__ { get; set; }
Property Value
Type Description
IDictionary<string, object>

RunTime

object representation of RunTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use RunTimeDateTimeOffset instead.")]
public virtual object RunTime { get; set; }
Property Value
Type Description
object

RunTimeDateTimeOffset

DateTimeOffset representation of RunTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? RunTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

RunTimeRaw

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

Declaration
[JsonProperty("runTime")]
public virtual string RunTimeRaw { get; set; }
Property Value
Type Description
string

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.

Declaration
[JsonProperty("schedule")]
public virtual string Schedule { get; set; }
Property Value
Type Description
string

ScheduleTime

object representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ScheduleTimeDateTimeOffset instead.")]
public virtual object ScheduleTime { get; set; }
Property Value
Type Description
object

ScheduleTimeDateTimeOffset

DateTimeOffset representation of ScheduleTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? ScheduleTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

ScheduleTimeRaw

Minimum time after which a transfer run can be started.

Declaration
[JsonProperty("scheduleTime")]
public virtual string ScheduleTimeRaw { get; set; }
Property Value
Type Description
string

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

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

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

State

Data transfer run state. Ignored for input requests.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

UserId

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

Declaration
[JsonProperty("userId")]
public virtual long? UserId { get; set; }
Property Value
Type Description
long?

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX