Class TimeBasedSchedule.Builder (2.54.0)

public static final class TimeBasedSchedule.Builder extends GeneratedMessageV3.Builder<TimeBasedSchedule.Builder> implements TimeBasedScheduleOrBuilder

Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public TimeBasedSchedule build()
Returns
Type Description
TimeBasedSchedule

buildPartial()

public TimeBasedSchedule buildPartial()
Returns
Type Description
TimeBasedSchedule

clear()

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

clearEndTime()

public TimeBasedSchedule.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.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
TimeBasedSchedule.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearSchedule()

public TimeBasedSchedule.Builder clearSchedule()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 1;

Returns
Type Description
TimeBasedSchedule.Builder

This builder for chaining.

clearStartTime()

public TimeBasedSchedule.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.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
TimeBasedSchedule.Builder

clone()

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

getDefaultInstanceForType()

public TimeBasedSchedule getDefaultInstanceForType()
Returns
Type Description
TimeBasedSchedule

getDescriptorForType()

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

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.

.google.protobuf.Timestamp end_time = 3;

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.

.google.protobuf.Timestamp end_time = 3;

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.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
TimestampOrBuilder

getSchedule()

public String getSchedule()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 1;

Returns
Type Description
String

The schedule.

getScheduleBytes()

public ByteString getScheduleBytes()

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 1;

Returns
Type Description
ByteString

The bytes for schedule.

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.

.google.protobuf.Timestamp start_time = 2;

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.

.google.protobuf.Timestamp start_time = 2;

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.

.google.protobuf.Timestamp start_time = 2;

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.

.google.protobuf.Timestamp end_time = 3;

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.

.google.protobuf.Timestamp start_time = 2;

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

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
TimeBasedSchedule.Builder

mergeFrom(TimeBasedSchedule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStartTime(Timestamp value)

public TimeBasedSchedule.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.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
TimeBasedSchedule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEndTime(Timestamp value)

public TimeBasedSchedule.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.

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
TimeBasedSchedule.Builder

setEndTime(Timestamp.Builder builderForValue)

public TimeBasedSchedule.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.

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TimeBasedSchedule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setSchedule(String value)

public TimeBasedSchedule.Builder setSchedule(String value)

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 1;

Parameter
Name Description
value String

The schedule to set.

Returns
Type Description
TimeBasedSchedule.Builder

This builder for chaining.

setScheduleBytes(ByteString value)

public TimeBasedSchedule.Builder setScheduleBytes(ByteString value)

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st,3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source.

string schedule = 1;

Parameter
Name Description
value ByteString

The bytes for schedule to set.

Returns
Type Description
TimeBasedSchedule.Builder

This builder for chaining.

setStartTime(Timestamp value)

public TimeBasedSchedule.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.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
TimeBasedSchedule.Builder

setStartTime(Timestamp.Builder builderForValue)

public TimeBasedSchedule.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.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TimeBasedSchedule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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