- 2.51.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
public static final class TransferRun.Builder extends GeneratedMessageV3.Builder<TransferRun.Builder> implements TransferRunOrBuilderRepresents a data transfer run.
Protobuf type google.cloud.bigquery.datatransfer.v1.TransferRun
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferRun.BuilderImplements
TransferRunOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferRun.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
build()
public TransferRun build()| Returns | |
|---|---|
| Type | Description |
TransferRun | |
buildPartial()
public TransferRun buildPartial()| Returns | |
|---|---|
| Type | Description |
TransferRun | |
clear()
public TransferRun.Builder clear()| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearDataSourceId()
public TransferRun.Builder clearDataSourceId()Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearDestination()
public TransferRun.Builder clearDestination()| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearDestinationDatasetId()
public TransferRun.Builder clearDestinationDatasetId()Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearEmailPreferences()
public TransferRun.Builder clearEmailPreferences()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 |
TransferRun.Builder | |
clearEndTime()
public TransferRun.Builder clearEndTime()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 |
TransferRun.Builder | |
clearErrorStatus()
public TransferRun.Builder clearErrorStatus()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearField(Descriptors.FieldDescriptor field)
public TransferRun.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearName()
public TransferRun.Builder clearName() 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;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearNotificationPubsubTopic()
public TransferRun.Builder clearNotificationPubsubTopic()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}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferRun.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearParams()
public TransferRun.Builder clearParams()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 |
TransferRun.Builder | |
clearRunTime()
public TransferRun.Builder clearRunTime()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearSchedule()
public TransferRun.Builder clearSchedule() 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 |
TransferRun.Builder | This builder for chaining. |
clearScheduleTime()
public TransferRun.Builder clearScheduleTime()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
clearStartTime()
public TransferRun.Builder clearStartTime()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 |
TransferRun.Builder | |
clearState()
public TransferRun.Builder clearState()Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clearUpdateTime()
public TransferRun.Builder clearUpdateTime()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 |
TransferRun.Builder | |
clearUserId()
public TransferRun.Builder clearUserId()Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
clone()
public TransferRun.Builder clone()| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
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 | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
getEmailPreferencesBuilder()
public EmailPreferences.Builder getEmailPreferencesBuilder()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.Builder | |
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. |
getEndTimeBuilder()
public Timestamp.Builder getEndTimeBuilder()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 |
Builder | |
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. |
getErrorStatusBuilder()
public Status.Builder getErrorStatusBuilder()Status of the transfer run.
.google.rpc.Status error_status = 21;
| Returns | |
|---|---|
| Type | Description |
com.google.rpc.Status.Builder | |
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() 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;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes() 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;
| 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}/topics/{topic}
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}/topics/{topic}
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. |
getParamsBuilder()
public Struct.Builder getParamsBuilder()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 |
Builder | |
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 | |
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. |
getRunTimeBuilder()
public Timestamp.Builder getRunTimeBuilder()For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Returns | |
|---|---|
| Type | Description |
Builder | |
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. |
getScheduleTimeBuilder()
public Timestamp.Builder getScheduleTimeBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
Builder | |
getScheduleTimeOrBuilder()
public TimestampOrBuilder getScheduleTimeOrBuilder()Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder | |
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. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()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 |
Builder | |
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()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 |
Builder | |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeEmailPreferences(EmailPreferences value)
public TransferRun.Builder mergeEmailPreferences(EmailPreferences value)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];
| Parameter | |
|---|---|
| Name | Description |
value | EmailPreferences |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeEndTime(Timestamp value)
public TransferRun.Builder mergeEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeErrorStatus(Status value)
public TransferRun.Builder mergeErrorStatus(Status value)Status of the transfer run.
.google.rpc.Status error_status = 21;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeFrom(TransferRun other)
public TransferRun.Builder mergeFrom(TransferRun other)| Parameter | |
|---|---|
| Name | Description |
other | TransferRun |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferRun.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public TransferRun.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeParams(Struct value)
public TransferRun.Builder mergeParams(Struct value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeRunTime(Timestamp value)
public TransferRun.Builder mergeRunTime(Timestamp value)For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeScheduleTime(Timestamp value)
public TransferRun.Builder mergeScheduleTime(Timestamp value)Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeStartTime(Timestamp value)
public TransferRun.Builder mergeStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferRun.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
mergeUpdateTime(Timestamp value)
public TransferRun.Builder mergeUpdateTime(Timestamp value)Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setDataSourceId(String value)
public TransferRun.Builder setDataSourceId(String value)Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe dataSourceId to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setDataSourceIdBytes(ByteString value)
public TransferRun.Builder setDataSourceIdBytes(ByteString value)Output only. Data source id.
string data_source_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for dataSourceId to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setDestinationDatasetId(String value)
public TransferRun.Builder setDestinationDatasetId(String value)Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe destinationDatasetId to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setDestinationDatasetIdBytes(ByteString value)
public TransferRun.Builder setDestinationDatasetIdBytes(ByteString value)Output only. The BigQuery target dataset id.
string destination_dataset_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for destinationDatasetId to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setEmailPreferences(EmailPreferences value)
public TransferRun.Builder setEmailPreferences(EmailPreferences value)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];
| Parameter | |
|---|---|
| Name | Description |
value | EmailPreferences |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setEmailPreferences(EmailPreferences.Builder builderForValue)
public TransferRun.Builder setEmailPreferences(EmailPreferences.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | EmailPreferences.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setEndTime(Timestamp value)
public TransferRun.Builder setEndTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setEndTime(Timestamp.Builder builderForValue)
public TransferRun.Builder setEndTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setErrorStatus(Status value)
public TransferRun.Builder setErrorStatus(Status value)Status of the transfer run.
.google.rpc.Status error_status = 21;
| Parameter | |
|---|---|
| Name | Description |
value | com.google.rpc.Status |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setErrorStatus(Status.Builder builderForValue)
public TransferRun.Builder setErrorStatus(Status.Builder builderForValue)Status of the transfer run.
.google.rpc.Status error_status = 21;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | com.google.rpc.Status.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public TransferRun.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setName(String value)
public TransferRun.Builder setName(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setNameBytes(ByteString value)
public TransferRun.Builder setNameBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setNotificationPubsubTopic(String value)
public TransferRun.Builder setNotificationPubsubTopic(String value)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}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe notificationPubsubTopic to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setNotificationPubsubTopicBytes(ByteString value)
public TransferRun.Builder setNotificationPubsubTopicBytes(ByteString value)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}
string notification_pubsub_topic = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for notificationPubsubTopic to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setParams(Struct value)
public TransferRun.Builder setParams(Struct value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Struct |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setParams(Struct.Builder builderForValue)
public TransferRun.Builder setParams(Struct.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferRun.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setRunTime(Timestamp value)
public TransferRun.Builder setRunTime(Timestamp value)For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setRunTime(Timestamp.Builder builderForValue)
public TransferRun.Builder setRunTime(Timestamp.Builder builderForValue)For batch transfer runs, specifies the date and time of the data should be ingested.
.google.protobuf.Timestamp run_time = 10;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setSchedule(String value)
public TransferRun.Builder setSchedule(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe schedule to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setScheduleBytes(ByteString value)
public TransferRun.Builder setScheduleBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for schedule to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setScheduleTime(Timestamp value)
public TransferRun.Builder setScheduleTime(Timestamp value)Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setScheduleTime(Timestamp.Builder builderForValue)
public TransferRun.Builder setScheduleTime(Timestamp.Builder builderForValue)Minimum time after which a transfer run can be started.
.google.protobuf.Timestamp schedule_time = 3;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setStartTime(Timestamp value)
public TransferRun.Builder setStartTime(Timestamp value)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];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setStartTime(Timestamp.Builder builderForValue)
public TransferRun.Builder setStartTime(Timestamp.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setState(TransferState value)
public TransferRun.Builder setState(TransferState value)Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Parameter | |
|---|---|
| Name | Description |
value | TransferStateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setStateValue(int value)
public TransferRun.Builder setStateValue(int value)Data transfer run state. Ignored for input requests.
.google.cloud.bigquery.datatransfer.v1.TransferState state = 8;
| Parameter | |
|---|---|
| Name | Description |
value | intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferRun.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setUpdateTime(Timestamp value)
public TransferRun.Builder setUpdateTime(Timestamp value)Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value | Timestamp |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setUpdateTime(Timestamp.Builder builderForValue)
public TransferRun.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Last time the data transfer run state was updated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | |
setUserId(long value)
public TransferRun.Builder setUserId(long value)Deprecated. Unique ID of the user on whose behalf transfer is done.
int64 user_id = 11;
| Parameter | |
|---|---|
| Name | Description |
value | longThe userId to set. |
| Returns | |
|---|---|
| Type | Description |
TransferRun.Builder | This builder for chaining. |