GoogleApi.StorageTransfer.V1.Model.Schedule (google_api_storage_transfer v0.26.2) View Source

Transfers can be scheduled to recur or to run just once.

Attributes

  • endTimeOfDay (type: GoogleApi.StorageTransfer.V1.Model.TimeOfDay.t, default: nil) - 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.
  • repeatInterval (type: String.t, default: nil) - 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.
  • scheduleEndDate (type: GoogleApi.StorageTransfer.V1.Model.Date.t, default: nil) - The last day a transfer runs. Date boundaries are determined relative to UTC time. A job will run 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 will run each day at start_time_of_day through schedule_end_date.
  • scheduleStartDate (type: GoogleApi.StorageTransfer.V1.Model.Date.t, default: nil) - 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 will start 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 will create a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation will take place on June 3 at midnight UTC.
  • startTimeOfDay (type: GoogleApi.StorageTransfer.V1.Model.TimeOfDay.t, default: nil) - 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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.StorageTransfer.V1.Model.Schedule{
  endTimeOfDay: GoogleApi.StorageTransfer.V1.Model.TimeOfDay.t() | nil,
  repeatInterval: String.t() | nil,
  scheduleEndDate: GoogleApi.StorageTransfer.V1.Model.Date.t() | nil,
  scheduleStartDate: GoogleApi.StorageTransfer.V1.Model.Date.t() | nil,
  startTimeOfDay: GoogleApi.StorageTransfer.V1.Model.TimeOfDay.t() | nil
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.