public static final class TransferTypes.Schedule extends GeneratedMessageV3 implements TransferTypes.ScheduleOrBuilder
Transfers can be scheduled to recur or to run just once.
Protobuf type google.storagetransfer.v1.Schedule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
END_TIME_OF_DAY_FIELD_NUMBER
public static final int END_TIME_OF_DAY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REPEAT_INTERVAL_FIELD_NUMBER
public static final int REPEAT_INTERVAL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCHEDULE_END_DATE_FIELD_NUMBER
public static final int SCHEDULE_END_DATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCHEDULE_START_DATE_FIELD_NUMBER
public static final int SCHEDULE_START_DATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
START_TIME_OF_DAY_FIELD_NUMBER
public static final int START_TIME_OF_DAY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TransferTypes.Schedule getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TransferTypes.Schedule.Builder newBuilder()
newBuilder(TransferTypes.Schedule prototype)
public static TransferTypes.Schedule.Builder newBuilder(TransferTypes.Schedule prototype)
public static TransferTypes.Schedule parseDelimitedFrom(InputStream input)
public static TransferTypes.Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TransferTypes.Schedule parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TransferTypes.Schedule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.Schedule parseFrom(CodedInputStream input)
public static TransferTypes.Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.Schedule parseFrom(InputStream input)
public static TransferTypes.Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TransferTypes.Schedule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TransferTypes.Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TransferTypes.Schedule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public TransferTypes.Schedule getDefaultInstanceForType()
getEndTimeOfDay()
public 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 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 |
|
getParserForType()
public Parser<TransferTypes.Schedule> getParserForType()
Overrides
getRepeatInterval()
public 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 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;
getScheduleEndDate()
public 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 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 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 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 |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStartTimeOfDay()
public 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 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 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TransferTypes.Schedule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TransferTypes.Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TransferTypes.Schedule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
