Class Schedule
Transfers can be scheduled to recur or to run just once.
Implements
Inherited Members
Namespace: Google.Apis.Storagetransfer.v1.Data
Assembly: Google.Apis.Storagetransfer.v1.dll
Syntax
public class Schedule : IDirectResponseSchema
Properties
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTimeOfDay
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.
Declaration
[JsonProperty("endTimeOfDay")]
public virtual TimeOfDay EndTimeOfDay { get; set; }
Property Value
Type | Description |
---|---|
TimeOfDay |
RepeatInterval
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.
Declaration
[JsonProperty("repeatInterval")]
public virtual object RepeatInterval { get; set; }
Property Value
Type | Description |
---|---|
object |
ScheduleEndDate
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
.
Declaration
[JsonProperty("scheduleEndDate")]
public virtual Date ScheduleEndDate { get; set; }
Property Value
Type | Description |
---|---|
Date |
ScheduleStartDate
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.
Declaration
[JsonProperty("scheduleStartDate")]
public virtual Date ScheduleStartDate { get; set; }
Property Value
Type | Description |
---|---|
Date |
StartTimeOfDay
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
.
Declaration
[JsonProperty("startTimeOfDay")]
public virtual TimeOfDay StartTimeOfDay { get; set; }
Property Value
Type | Description |
---|---|
TimeOfDay |