Interface TransferTypes.ScheduleOrBuilder (1.31.0)

Version 1.31.0

• 1.54.0 (latest)
• 1.53.0
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.0.4

public static interface TransferTypes.ScheduleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndTimeOfDay()

public abstract TimeOfDay getEndTimeOfDay()

The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_day specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following:

• If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.

• If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
com.google.type.TimeOfDay	The endTimeOfDay.

getEndTimeOfDayOrBuilder()

public abstract TimeOfDayOrBuilder getEndTimeOfDayOrBuilder()

The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_day specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following:

• If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.

• If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
com.google.type.TimeOfDayOrBuilder

getRepeatInterval()

public abstract Duration getRepeatInterval()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
Duration	The repeatInterval.

getRepeatIntervalOrBuilder()

public abstract DurationOrBuilder getRepeatIntervalOrBuilder()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
DurationOrBuilder

getScheduleEndDate()

public abstract Date getScheduleEndDate()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

• If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
• If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
com.google.type.Date	The scheduleEndDate.

getScheduleEndDateOrBuilder()

public abstract DateOrBuilder getScheduleEndDateOrBuilder()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

• If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
• If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
com.google.type.DateOrBuilder

getScheduleStartDate()

public abstract Date getScheduleStartDate()

Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_date and start_time_of_day are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request.

Note: When starting jobs at or near midnight UTC it is possible that a job starts later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it creates a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
com.google.type.Date	The scheduleStartDate.

getScheduleStartDateOrBuilder()

public abstract DateOrBuilder getScheduleStartDateOrBuilder()

Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_date and start_time_of_day are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request.

Note: When starting jobs at or near midnight UTC it is possible that a job starts later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it creates a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
com.google.type.DateOrBuilder

getStartTimeOfDay()

public abstract TimeOfDay getStartTimeOfDay()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

• One-time transfers run immediately.

• Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

  If start_time_of_day is specified:

• One-time transfers run at the specified time.

• Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
com.google.type.TimeOfDay	The startTimeOfDay.

getStartTimeOfDayOrBuilder()

public abstract TimeOfDayOrBuilder getStartTimeOfDayOrBuilder()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

• One-time transfers run immediately.

• Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

  If start_time_of_day is specified:

• One-time transfers run at the specified time.

• Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
com.google.type.TimeOfDayOrBuilder

hasEndTimeOfDay()

public abstract boolean hasEndTimeOfDay()

The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_day specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following:

• If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.

• If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
boolean	Whether the endTimeOfDay field is set.

hasRepeatInterval()

public abstract boolean hasRepeatInterval()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
boolean	Whether the repeatInterval field is set.

hasScheduleEndDate()

public abstract boolean hasScheduleEndDate()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

• If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
• If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
boolean	Whether the scheduleEndDate field is set.

hasScheduleStartDate()

public abstract boolean hasScheduleStartDate()

Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_date and start_time_of_day are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request.

Note: When starting jobs at or near midnight UTC it is possible that a job starts later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it creates a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the scheduleStartDate field is set.

hasStartTimeOfDay()

public abstract boolean hasStartTimeOfDay()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

• One-time transfers run immediately.

• Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

  If start_time_of_day is specified:

• One-time transfers run at the specified time.

• Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
boolean	Whether the startTimeOfDay field is set.