com.google.storagetransfer.v1.proto

Interface TransferTypes.ScheduleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TransferTypes.Schedule, TransferTypes.Schedule.Builder

Enclosing class:

TransferTypes

public static interface TransferTypes.ScheduleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.type.TimeOfDay	getEndTimeOfDay() The time in UTC that no further transfer operations are scheduled.
com.google.type.TimeOfDayOrBuilder	getEndTimeOfDayOrBuilder() The time in UTC that no further transfer operations are scheduled.
com.google.protobuf.Duration	getRepeatInterval() Interval between the start of each scheduled TransferOperation.
com.google.protobuf.DurationOrBuilder	getRepeatIntervalOrBuilder() Interval between the start of each scheduled TransferOperation.
com.google.type.Date	getScheduleEndDate() The last day a transfer runs.
com.google.type.DateOrBuilder	getScheduleEndDateOrBuilder() The last day a transfer runs.
com.google.type.Date	getScheduleStartDate() Required.
com.google.type.DateOrBuilder	getScheduleStartDateOrBuilder() Required.
com.google.type.TimeOfDay	getStartTimeOfDay() The time in UTC that a transfer job is scheduled to run.
com.google.type.TimeOfDayOrBuilder	getStartTimeOfDayOrBuilder() The time in UTC that a transfer job is scheduled to run.
boolean	hasEndTimeOfDay() The time in UTC that no further transfer operations are scheduled.
boolean	hasRepeatInterval() Interval between the start of each scheduled TransferOperation.
boolean	hasScheduleEndDate() The last day a transfer runs.
boolean	hasScheduleStartDate() Required.
boolean	hasStartTimeOfDay() The time in UTC that a transfer job is scheduled to run.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasScheduleStartDate

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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.TransferOperation] takes place on June 3 at midnight UTC.
 

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

Returns:

Whether the scheduleStartDate field is set.

getScheduleStartDate

com.google.type.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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.TransferOperation] takes place on June 3 at midnight UTC.
 

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

Returns:

The scheduleStartDate.

getScheduleStartDateOrBuilder

com.google.type.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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.TransferOperation] takes place on June 3 at midnight UTC.
 

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

hasScheduleEndDate

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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.start_time_of_day] through `schedule_end_date`.
 

.google.type.Date schedule_end_date = 2;

Returns:

Whether the scheduleEndDate field is set.

getScheduleEndDate

com.google.type.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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.start_time_of_day] through `schedule_end_date`.
 

.google.type.Date schedule_end_date = 2;

Returns:

The scheduleEndDate.

getScheduleEndDateOrBuilder

com.google.type.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][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.start_time_of_day] through `schedule_end_date`.
 

.google.type.Date schedule_end_date = 2;

hasStartTimeOfDay

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][google.storagetransfer.v1.Schedule.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:

Whether the startTimeOfDay field is set.

getStartTimeOfDay

com.google.type.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][google.storagetransfer.v1.Schedule.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:

The startTimeOfDay.

getStartTimeOfDayOrBuilder

com.google.type.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][google.storagetransfer.v1.Schedule.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;

hasEndTimeOfDay

boolean hasEndTimeOfDay()

 The time in UTC that no further transfer operations are scheduled. Combined
 with [schedule_end_date][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.schedule_start_date] and [start_time_of_day][google.storagetransfer.v1.Schedule.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][google.rpc.Code.INVALID_ARGUMENT] is returned.
 

.google.type.TimeOfDay end_time_of_day = 4;

Returns:

Whether the endTimeOfDay field is set.

getEndTimeOfDay

com.google.type.TimeOfDay getEndTimeOfDay()

 The time in UTC that no further transfer operations are scheduled. Combined
 with [schedule_end_date][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.schedule_start_date] and [start_time_of_day][google.storagetransfer.v1.Schedule.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][google.rpc.Code.INVALID_ARGUMENT] is returned.
 

.google.type.TimeOfDay end_time_of_day = 4;

Returns:

The endTimeOfDay.

getEndTimeOfDayOrBuilder

com.google.type.TimeOfDayOrBuilder getEndTimeOfDayOrBuilder()

 The time in UTC that no further transfer operations are scheduled. Combined
 with [schedule_end_date][google.storagetransfer.v1.Schedule.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][google.storagetransfer.v1.Schedule.schedule_start_date] and [start_time_of_day][google.storagetransfer.v1.Schedule.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][google.rpc.Code.INVALID_ARGUMENT] is returned.
 

.google.type.TimeOfDay end_time_of_day = 4;

hasRepeatInterval

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:

Whether the repeatInterval field is set.

getRepeatInterval

com.google.protobuf.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:

The repeatInterval.

getRepeatIntervalOrBuilder

com.google.protobuf.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;