Package com.google.storagetransfer.v1.proto

Class TransferTypes.Schedule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.storagetransfer.v1.proto.TransferTypes.Schedule
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TransferTypes.ScheduleOrBuilder, Serializable
Enclosing class:
TransferTypes
public static final class TransferTypes.Schedule extends com.google.protobuf.GeneratedMessage implements TransferTypes.ScheduleOrBuilder
 Transfers can be scheduled to recur or to run just once.
Protobuf type google.storagetransfer.v1.Schedule
See Also:

  • Field Details

    • SCHEDULE_START_DATE_FIELD_NUMBER

      public static final int SCHEDULE_START_DATE_FIELD_NUMBER
      See Also:

    • SCHEDULE_END_DATE_FIELD_NUMBER

      public static final int SCHEDULE_END_DATE_FIELD_NUMBER
      See Also:

    • START_TIME_OF_DAY_FIELD_NUMBER

      public static final int START_TIME_OF_DAY_FIELD_NUMBER
      See Also:

    • END_TIME_OF_DAY_FIELD_NUMBER

      public static final int END_TIME_OF_DAY_FIELD_NUMBER
      See Also:

    • REPEAT_INTERVAL_FIELD_NUMBER

      public static final int REPEAT_INTERVAL_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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][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];
      Specified by:
      hasScheduleStartDate in interface TransferTypes.ScheduleOrBuilder
      Returns:
      Whether the scheduleStartDate field is set.

    • 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][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];
      Specified by:
      getScheduleStartDate in interface TransferTypes.ScheduleOrBuilder
      Returns:
      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][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];
      Specified by:
      getScheduleStartDateOrBuilder in interface TransferTypes.ScheduleOrBuilder

    • 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][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;
      Specified by:
      hasScheduleEndDate in interface TransferTypes.ScheduleOrBuilder
      Returns:
      Whether the scheduleEndDate field is set.

    • 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][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;
      Specified by:
      getScheduleEndDate in interface TransferTypes.ScheduleOrBuilder
      Returns:
      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][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;
      Specified by:
      getScheduleEndDateOrBuilder in interface TransferTypes.ScheduleOrBuilder

    • 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][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;
      Specified by:
      hasStartTimeOfDay in interface TransferTypes.ScheduleOrBuilder
      Returns:
      Whether the startTimeOfDay field is set.

    • 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][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;
      Specified by:
      getStartTimeOfDay in interface TransferTypes.ScheduleOrBuilder
      Returns:
      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][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;
      Specified by:
      getStartTimeOfDayOrBuilder in interface TransferTypes.ScheduleOrBuilder

    • hasEndTimeOfDay

      public 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 combination 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;
      Specified by:
      hasEndTimeOfDay in interface TransferTypes.ScheduleOrBuilder
      Returns:
      Whether the endTimeOfDay field is set.

    • getEndTimeOfDay

      public 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 combination 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;
      Specified by:
      getEndTimeOfDay in interface TransferTypes.ScheduleOrBuilder
      Returns:
      The endTimeOfDay.

    • getEndTimeOfDayOrBuilder

      public 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 combination 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;
      Specified by:
      getEndTimeOfDayOrBuilder in interface TransferTypes.ScheduleOrBuilder

    • 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;
      Specified by:
      hasRepeatInterval in interface TransferTypes.ScheduleOrBuilder
      Returns:
      Whether the repeatInterval field is set.

    • getRepeatInterval

      public 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;
      Specified by:
      getRepeatInterval in interface TransferTypes.ScheduleOrBuilder
      Returns:
      The repeatInterval.

    • getRepeatIntervalOrBuilder

      public 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;
      Specified by:
      getRepeatIntervalOrBuilder in interface TransferTypes.ScheduleOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static TransferTypes.Schedule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.Schedule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TransferTypes.Schedule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TransferTypes.Schedule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public TransferTypes.Schedule.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static TransferTypes.Schedule.Builder newBuilder()

    • newBuilder

      public static TransferTypes.Schedule.Builder newBuilder(TransferTypes.Schedule prototype)

    • toBuilder

      public TransferTypes.Schedule.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected TransferTypes.Schedule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TransferTypes.Schedule getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<TransferTypes.Schedule> parser()

    • getParserForType

      public com.google.protobuf.Parser<TransferTypes.Schedule> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public TransferTypes.Schedule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder