Class TransferRun (2.44.0) 

public final class TransferRun extends GeneratedMessageV3 implements TransferRunOrBuilder

Represents a data transfer run.

Protobuf type google.cloud.bigquery.datatransfer.v1.TransferRun

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferRun

Static Fields

DATA_SOURCE_ID_FIELD_NUMBER

public static final int DATA_SOURCE_ID_FIELD_NUMBER
Field Value
Type Description
int

DESTINATION_DATASET_ID_FIELD_NUMBER

public static final int DESTINATION_DATASET_ID_FIELD_NUMBER
Field Value
Type Description
int

EMAIL_PREFERENCES_FIELD_NUMBER

public static final int EMAIL_PREFERENCES_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

ERROR_STATUS_FIELD_NUMBER

public static final int ERROR_STATUS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER

public static final int NOTIFICATION_PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER
Field Value
Type Description
int

RUN_TIME_FIELD_NUMBER

public static final int RUN_TIME_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransferRun getDefaultInstance()
Returns
Type Description
TransferRun

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TransferRun.Builder newBuilder()
Returns
Type Description
TransferRun.Builder

newBuilder(TransferRun prototype)

public static TransferRun.Builder newBuilder(TransferRun prototype)
Parameter
Name Description
prototype TransferRun
Returns
Type Description
TransferRun.Builder

parseDelimitedFrom(InputStream input)

public static TransferRun parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransferRun parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransferRun parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransferRun parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransferRun parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransferRun parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferRun parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransferRun
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransferRun> parser()
Returns
Type Description
Parser<TransferRun>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDataSourceId()

public String getDataSourceId()

Output only. Data source id.

string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dataSourceId.

getDataSourceIdBytes()

public ByteString getDataSourceIdBytes()

Output only. Data source id.

string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dataSourceId.

getDefaultInstanceForType()

public TransferRun getDefaultInstanceForType()
Returns
Type Description
TransferRun

getDestinationCase()

public TransferRun.DestinationCase getDestinationCase()
Returns
Type Description
TransferRun.DestinationCase

getDestinationDatasetId()

public String getDestinationDatasetId()

Output only. The BigQuery target dataset id.

string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The destinationDatasetId.

getDestinationDatasetIdBytes()

public ByteString getDestinationDatasetIdBytes()

Output only. The BigQuery target dataset id.

string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for destinationDatasetId.

getEmailPreferences()

public EmailPreferences getEmailPreferences()

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.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EmailPreferences

The emailPreferences.

getEmailPreferencesOrBuilder()

public EmailPreferencesOrBuilder getEmailPreferencesOrBuilder()

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.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EmailPreferencesOrBuilder

getEndTime()

public Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getErrorStatus()

public Status getErrorStatus()

Status of the transfer run.

.google.rpc.Status error_status = 21;

Returns
Type Description
com.google.rpc.Status

The errorStatus.

getErrorStatusOrBuilder()

public StatusOrBuilder getErrorStatusOrBuilder()

Status of the transfer run.

.google.rpc.Status error_status = 21;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getName()

public String getName()

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.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotificationPubsubTopic()

public String getNotificationPubsubTopic()

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}

string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The notificationPubsubTopic.

getNotificationPubsubTopicBytes()

public ByteString getNotificationPubsubTopicBytes()

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}

string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for notificationPubsubTopic.

getParams()

public Struct getParams()

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

.google.protobuf.Struct params = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Struct

The params.

getParamsOrBuilder()

public StructOrBuilder getParamsOrBuilder()

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

.google.protobuf.Struct params = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StructOrBuilder

getParserForType()

public Parser<TransferRun> getParserForType()
Returns
Type Description
Parser<TransferRun>
Overrides

getRunTime()

public Timestamp getRunTime()

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

.google.protobuf.Timestamp run_time = 10;

Returns
Type Description
Timestamp

The runTime.

getRunTimeOrBuilder()

public TimestampOrBuilder getRunTimeOrBuilder()

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

.google.protobuf.Timestamp run_time = 10;

Returns
Type Description
TimestampOrBuilder

getSchedule()

public String getSchedule()

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.

string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

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.

string schedule = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for schedule.

getScheduleTime()

public Timestamp getScheduleTime()

Minimum time after which a transfer run can be started.

.google.protobuf.Timestamp schedule_time = 3;

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeOrBuilder()

public TimestampOrBuilder getScheduleTimeOrBuilder()

Minimum time after which a transfer run can be started.

.google.protobuf.Timestamp schedule_time = 3;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

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

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

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

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public TransferState getState()

Data transfer run state. Ignored for input requests.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;

Returns
Type Description
TransferState

The state.

getStateValue()

public int getStateValue()

Data transfer run state. Ignored for input requests.

.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUserId()

public long getUserId()

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

int64 user_id = 11;

Returns
Type Description
long

The userId.

hasDestinationDatasetId()

public boolean hasDestinationDatasetId()

Output only. The BigQuery target dataset id.

string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the destinationDatasetId field is set.

hasEmailPreferences()

public boolean hasEmailPreferences()

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.

.google.cloud.bigquery.datatransfer.v1.EmailPreferences email_preferences = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the emailPreferences field is set.

hasEndTime()

public boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasErrorStatus()

public boolean hasErrorStatus()

Status of the transfer run.

.google.rpc.Status error_status = 21;

Returns
Type Description
boolean

Whether the errorStatus field is set.

hasParams()

public boolean hasParams()

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

.google.protobuf.Struct params = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the params field is set.

hasRunTime()

public boolean hasRunTime()

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

.google.protobuf.Timestamp run_time = 10;

Returns
Type Description
boolean

Whether the runTime field is set.

hasScheduleTime()

public boolean hasScheduleTime()

Minimum time after which a transfer run can be started.

.google.protobuf.Timestamp schedule_time = 3;

Returns
Type Description
boolean

Whether the scheduleTime field is set.

hasStartTime()

public boolean hasStartTime()

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

.google.protobuf.Timestamp start_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TransferRun.Builder newBuilderForType()
Returns
Type Description
TransferRun.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferRun.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransferRun.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TransferRun.Builder toBuilder()
Returns
Type Description
TransferRun.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException