Class ScheduleOptions.Builder (2.43.0)

public static final class ScheduleOptions.Builder extends GeneratedMessageV3.Builder<ScheduleOptions.Builder> implements ScheduleOptionsOrBuilder

Options customizing the data transfer schedule.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ScheduleOptions.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ScheduleOptions.Builder
Overrides

build()

public ScheduleOptions build()
Returns
Type Description
ScheduleOptions

buildPartial()

public ScheduleOptions buildPartial()
Returns
Type Description
ScheduleOptions

clear()

public ScheduleOptions.Builder clear()
Returns
Type Description
ScheduleOptions.Builder
Overrides

clearDisableAutoScheduling()

public ScheduleOptions.Builder clearDisableAutoScheduling()

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

bool disable_auto_scheduling = 3;

Returns
Type Description
ScheduleOptions.Builder

This builder for chaining.

clearEndTime()

public ScheduleOptions.Builder clearEndTime()

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
ScheduleOptions.Builder

clearField(Descriptors.FieldDescriptor field)

public ScheduleOptions.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ScheduleOptions.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ScheduleOptions.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ScheduleOptions.Builder
Overrides

clearStartTime()

public ScheduleOptions.Builder clearStartTime()

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
ScheduleOptions.Builder

clone()

public ScheduleOptions.Builder clone()
Returns
Type Description
ScheduleOptions.Builder
Overrides

getDefaultInstanceForType()

public ScheduleOptions getDefaultInstanceForType()
Returns
Type Description
ScheduleOptions

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableAutoScheduling()

public boolean getDisableAutoScheduling()

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

bool disable_auto_scheduling = 3;

Returns
Type Description
boolean

The disableAutoScheduling.

getEndTime()

public Timestamp getEndTime()

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
TimestampOrBuilder

getStartTime()

public Timestamp getStartTime()

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Returns
Type Description
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public ScheduleOptions.Builder mergeEndTime(Timestamp value)

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ScheduleOptions.Builder

mergeFrom(ScheduleOptions other)

public ScheduleOptions.Builder mergeFrom(ScheduleOptions other)
Parameter
Name Description
other ScheduleOptions
Returns
Type Description
ScheduleOptions.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ScheduleOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptions.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ScheduleOptions.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ScheduleOptions.Builder
Overrides

mergeStartTime(Timestamp value)

public ScheduleOptions.Builder mergeStartTime(Timestamp value)

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ScheduleOptions.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ScheduleOptions.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ScheduleOptions.Builder
Overrides

setDisableAutoScheduling(boolean value)

public ScheduleOptions.Builder setDisableAutoScheduling(boolean value)

If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored.

bool disable_auto_scheduling = 3;

Parameter
Name Description
value boolean

The disableAutoScheduling to set.

Returns
Type Description
ScheduleOptions.Builder

This builder for chaining.

setEndTime(Timestamp value)

public ScheduleOptions.Builder setEndTime(Timestamp value)

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
ScheduleOptions.Builder

setEndTime(Timestamp.Builder builderForValue)

public ScheduleOptions.Builder setEndTime(Timestamp.Builder builderForValue)

Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp end_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ScheduleOptions.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ScheduleOptions.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ScheduleOptions.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ScheduleOptions.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ScheduleOptions.Builder
Overrides

setStartTime(Timestamp value)

public ScheduleOptions.Builder setStartTime(Timestamp value)

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
ScheduleOptions.Builder

setStartTime(Timestamp.Builder builderForValue)

public ScheduleOptions.Builder setStartTime(Timestamp.Builder builderForValue)

Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option.

.google.protobuf.Timestamp start_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ScheduleOptions.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ScheduleOptions.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ScheduleOptions.Builder
Overrides