Package com.oracle.bmc.filestorage.model

Class SnapshotSchedule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.filestorage.model.SnapshotSchedule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20171215")
public final class SnapshotSchedule
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The snapshot schedule is a structure within a parent file system snapshot policy.

It contains data about the frequency of snapshot creation and the retention time of the taken snapshots.
Note: Objects should always be created or deserialized using the SnapshotSchedule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the SnapshotSchedule.Builder, which maintain a set of all explicitly set fields called SnapshotSchedule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnapshotSchedule.Builder
static class	SnapshotSchedule.DayOfWeek	The day of the week to create a scheduled snapshot.
static class	SnapshotSchedule.Month	The month to create a scheduled snapshot.
static class	SnapshotSchedule.Period	The frequency of scheduled snapshots.
static class	SnapshotSchedule.TimeZone	Time zone used for scheduling the snapshot.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
SnapshotSchedule(String schedulePrefix, Date timeScheduleStart, SnapshotSchedule.Period period, Long retentionDurationInSeconds, SnapshotSchedule.TimeZone timeZone, Integer hourOfDay, SnapshotSchedule.DayOfWeek dayOfWeek, Integer dayOfMonth, SnapshotSchedule.Month month)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static SnapshotSchedule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getDayOfMonth()	The day of the month to create a scheduled snapshot.
SnapshotSchedule.DayOfWeek	getDayOfWeek()	The day of the week to create a scheduled snapshot.
Integer	getHourOfDay()	The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot.
SnapshotSchedule.Month	getMonth()	The month to create a scheduled snapshot.
SnapshotSchedule.Period	getPeriod()	The frequency of scheduled snapshots.
Long	getRetentionDurationInSeconds()	The number of seconds to retain snapshots created with this schedule.
String	getSchedulePrefix()	A name prefix to be applied to snapshots created by this schedule.
Date	getTimeScheduleStart()	The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format.
SnapshotSchedule.TimeZone	getTimeZone()	Time zone used for scheduling the snapshot.
int	hashCode()
SnapshotSchedule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotSchedule

@Deprecated
@ConstructorProperties({"schedulePrefix","timeScheduleStart","period","retentionDurationInSeconds","timeZone","hourOfDay","dayOfWeek","dayOfMonth","month"})
public SnapshotSchedule(String schedulePrefix,
                        Date timeScheduleStart,
                        SnapshotSchedule.Period period,
                        Long retentionDurationInSeconds,
                        SnapshotSchedule.TimeZone timeZone,
                        Integer hourOfDay,
                        SnapshotSchedule.DayOfWeek dayOfWeek,
                        Integer dayOfMonth,
                        SnapshotSchedule.Month month)

Deprecated.

Method Detail

builder

public static SnapshotSchedule.Builder builder()

Create a new builder.

toBuilder

public SnapshotSchedule.Builder toBuilder()

getSchedulePrefix

public String getSchedulePrefix()

A name prefix to be applied to snapshots created by this schedule.

Example: compliance1

Returns:

the value

getTimeScheduleStart

public Date getTimeScheduleStart()

The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format.

If no timeScheduleStart is provided, the value will be set to the time when the schedule was created.

Returns:

the value

getPeriod

public SnapshotSchedule.Period getPeriod()

The frequency of scheduled snapshots.

Returns:

the value

getRetentionDurationInSeconds

public Long getRetentionDurationInSeconds()

The number of seconds to retain snapshots created with this schedule.

Snapshot expiration time will not be set if this value is empty.

Returns:

the value

getTimeZone

public SnapshotSchedule.TimeZone getTimeZone()

Time zone used for scheduling the snapshot.

Returns:

the value

getHourOfDay

public Integer getHourOfDay()

The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot.

If not set, the system chooses a value at creation time.

Returns:

the value

getDayOfWeek

public SnapshotSchedule.DayOfWeek getDayOfWeek()

The day of the week to create a scheduled snapshot.

Used for WEEKLY snapshot schedules. If not set, the system chooses a value at creation time.

Returns:

the value

getDayOfMonth

public Integer getDayOfMonth()

The day of the month to create a scheduled snapshot.

If the day does not exist for the month, snapshot creation will be skipped. Used for MONTHLY and YEARLY snapshot schedules. If not set, the system chooses a value at creation time.

Returns:

the value

getMonth

public SnapshotSchedule.Month getMonth()

The month to create a scheduled snapshot.

Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel