com.google.api.services.storagetransfer.v1.model

Class Schedule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.storagetransfer.v1.model.Schedule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Schedule
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Storage Transfer API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Schedule()

Method Summary

Modifier and Type	Method and Description
Schedule	clone()
TimeOfDay	getEndTimeOfDay() The time in UTC that no further transfer operations are scheduled.
String	getRepeatInterval() Interval between the start of each scheduled TransferOperation.
Date	getScheduleEndDate() The last day a transfer runs.
Date	getScheduleStartDate() Required.
TimeOfDay	getStartTimeOfDay() The time in UTC that a transfer job is scheduled to run.
Schedule	set(String fieldName, Object value)
Schedule	setEndTimeOfDay(TimeOfDay endTimeOfDay) The time in UTC that no further transfer operations are scheduled.
Schedule	setRepeatInterval(String repeatInterval) Interval between the start of each scheduled TransferOperation.
Schedule	setScheduleEndDate(Date scheduleEndDate) The last day a transfer runs.
Schedule	setScheduleStartDate(Date scheduleStartDate) Required.
Schedule	setStartTimeOfDay(TimeOfDay startTimeOfDay) The time in UTC that a transfer job is scheduled to run.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Schedule

public Schedule()

Method Detail

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.

Returns:

value or null for none

setEndTimeOfDay

public Schedule setEndTimeOfDay(TimeOfDay 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.

Parameters:

endTimeOfDay - endTimeOfDay or null for none

getRepeatInterval

public String 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.

Returns:

value or null for none

setRepeatInterval

public Schedule setRepeatInterval(String 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.

Parameters:

repeatInterval - repeatInterval or null for none

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`.

Returns:

value or null for none

setScheduleEndDate

public Schedule setScheduleEndDate(Date 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`.

Parameters:

scheduleEndDate - scheduleEndDate or null for none

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.

Returns:

value or null for none

setScheduleStartDate

public Schedule setScheduleStartDate(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.

Parameters:

scheduleStartDate - scheduleStartDate or null for none

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`.

Returns:

value or null for none

setStartTimeOfDay

public Schedule setStartTimeOfDay(TimeOfDay 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`.

Parameters:

startTimeOfDay - startTimeOfDay or null for none

set

public Schedule set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Schedule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson