public static final class TransferTypes.Schedule extends com.google.protobuf.GeneratedMessageV3 implements TransferTypes.ScheduleOrBuilder
Transfers can be scheduled to recur or to run just once.Protobuf type
google.storagetransfer.v1.Schedule| Modifier and Type | Class and Description |
|---|---|
static class |
TransferTypes.Schedule.Builder
Transfers can be scheduled to recur or to run just once.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
END_TIME_OF_DAY_FIELD_NUMBER |
static int |
REPEAT_INTERVAL_FIELD_NUMBER |
static int |
SCHEDULE_END_DATE_FIELD_NUMBER |
static int |
SCHEDULE_START_DATE_FIELD_NUMBER |
static int |
START_TIME_OF_DAY_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
static TransferTypes.Schedule |
getDefaultInstance() |
TransferTypes.Schedule |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
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.Parser<TransferTypes.Schedule> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasEndTimeOfDay()
The time in UTC that no further transfer operations are scheduled.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static TransferTypes.Schedule.Builder |
newBuilder() |
static TransferTypes.Schedule.Builder |
newBuilder(TransferTypes.Schedule prototype) |
TransferTypes.Schedule.Builder |
newBuilderForType() |
protected TransferTypes.Schedule.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static TransferTypes.Schedule |
parseDelimitedFrom(InputStream input) |
static TransferTypes.Schedule |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TransferTypes.Schedule |
parseFrom(byte[] data) |
static TransferTypes.Schedule |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TransferTypes.Schedule |
parseFrom(ByteBuffer data) |
static TransferTypes.Schedule |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TransferTypes.Schedule |
parseFrom(com.google.protobuf.ByteString data) |
static TransferTypes.Schedule |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TransferTypes.Schedule |
parseFrom(com.google.protobuf.CodedInputStream input) |
static TransferTypes.Schedule |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static TransferTypes.Schedule |
parseFrom(InputStream input) |
static TransferTypes.Schedule |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<TransferTypes.Schedule> |
parser() |
TransferTypes.Schedule.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int SCHEDULE_START_DATE_FIELD_NUMBER
public static final int SCHEDULE_END_DATE_FIELD_NUMBER
public static final int START_TIME_OF_DAY_FIELD_NUMBER
public static final int END_TIME_OF_DAY_FIELD_NUMBER
public static final int REPEAT_INTERVAL_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];
hasScheduleStartDate in interface TransferTypes.ScheduleOrBuilderpublic 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];
getScheduleStartDate in interface TransferTypes.ScheduleOrBuilderpublic 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];
getScheduleStartDateOrBuilder in interface TransferTypes.ScheduleOrBuilderpublic 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;hasScheduleEndDate in interface TransferTypes.ScheduleOrBuilderpublic 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;getScheduleEndDate in interface TransferTypes.ScheduleOrBuilderpublic 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;getScheduleEndDateOrBuilder in interface TransferTypes.ScheduleOrBuilderpublic 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;hasStartTimeOfDay in interface TransferTypes.ScheduleOrBuilderpublic 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;getStartTimeOfDay in interface TransferTypes.ScheduleOrBuilderpublic 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;getStartTimeOfDayOrBuilder in interface TransferTypes.ScheduleOrBuilderpublic 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;hasEndTimeOfDay in interface TransferTypes.ScheduleOrBuilderpublic 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;getEndTimeOfDay in interface TransferTypes.ScheduleOrBuilderpublic 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;getEndTimeOfDayOrBuilder in interface TransferTypes.ScheduleOrBuilderpublic 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;hasRepeatInterval in interface TransferTypes.ScheduleOrBuilderpublic 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;getRepeatInterval in interface TransferTypes.ScheduleOrBuilderpublic 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;getRepeatIntervalOrBuilder in interface TransferTypes.ScheduleOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static TransferTypes.Schedule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static TransferTypes.Schedule parseFrom(InputStream input) throws IOException
IOExceptionpublic static TransferTypes.Schedule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TransferTypes.Schedule parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static TransferTypes.Schedule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static TransferTypes.Schedule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static TransferTypes.Schedule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic TransferTypes.Schedule.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static TransferTypes.Schedule.Builder newBuilder()
public static TransferTypes.Schedule.Builder newBuilder(TransferTypes.Schedule prototype)
public TransferTypes.Schedule.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected TransferTypes.Schedule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static TransferTypes.Schedule getDefaultInstance()
public static com.google.protobuf.Parser<TransferTypes.Schedule> parser()
public com.google.protobuf.Parser<TransferTypes.Schedule> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public TransferTypes.Schedule getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.