Package com.oracle.bmc.core.model

Class VolumeBackupSchedule

java.lang.Object

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

com.oracle.bmc.core.model.VolumeBackupSchedule

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

Defines the backup frequency and retention period for a volume backup policy.

For more information, see Policy-Based Backups.
Note: Objects should always be created or deserialized using the VolumeBackupSchedule.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 VolumeBackupSchedule.Builder, which maintain a set of all explicitly set fields called VolumeBackupSchedule.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	VolumeBackupSchedule.BackupType	The type of volume backup to create.
static class	VolumeBackupSchedule.Builder
static class	VolumeBackupSchedule.DayOfWeek	The day of the week to schedule the volume backup.
static class	VolumeBackupSchedule.Month	The month of the year to schedule the volume backup.
static class	VolumeBackupSchedule.OffsetType	Indicates how the offset is defined.
static class	VolumeBackupSchedule.Period	The volume backup frequency.
static class	VolumeBackupSchedule.TimeZone	Specifies what time zone is the schedule in

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
VolumeBackupSchedule(VolumeBackupSchedule.BackupType backupType, Integer offsetSeconds, VolumeBackupSchedule.Period period, VolumeBackupSchedule.OffsetType offsetType, Integer hourOfDay, VolumeBackupSchedule.DayOfWeek dayOfWeek, Integer dayOfMonth, VolumeBackupSchedule.Month month, Integer retentionSeconds, VolumeBackupSchedule.TimeZone timeZone)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static VolumeBackupSchedule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
VolumeBackupSchedule.BackupType	getBackupType()	The type of volume backup to create.
Integer	getDayOfMonth()	The day of the month to schedule the volume backup.
VolumeBackupSchedule.DayOfWeek	getDayOfWeek()	The day of the week to schedule the volume backup.
Integer	getHourOfDay()	The hour of the day to schedule the volume backup.
VolumeBackupSchedule.Month	getMonth()	The month of the year to schedule the volume backup.
Integer	getOffsetSeconds()	The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period.
VolumeBackupSchedule.OffsetType	getOffsetType()	Indicates how the offset is defined.
VolumeBackupSchedule.Period	getPeriod()	The volume backup frequency.
Integer	getRetentionSeconds()	How long, in seconds, to keep the volume backups created by this schedule.
VolumeBackupSchedule.TimeZone	getTimeZone()	Specifies what time zone is the schedule in
int	hashCode()
VolumeBackupSchedule.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

VolumeBackupSchedule

@Deprecated
@ConstructorProperties({"backupType","offsetSeconds","period","offsetType","hourOfDay","dayOfWeek","dayOfMonth","month","retentionSeconds","timeZone"})
public VolumeBackupSchedule(VolumeBackupSchedule.BackupType backupType,
                            Integer offsetSeconds,
                            VolumeBackupSchedule.Period period,
                            VolumeBackupSchedule.OffsetType offsetType,
                            Integer hourOfDay,
                            VolumeBackupSchedule.DayOfWeek dayOfWeek,
                            Integer dayOfMonth,
                            VolumeBackupSchedule.Month month,
                            Integer retentionSeconds,
                            VolumeBackupSchedule.TimeZone timeZone)

Deprecated.

Method Detail

builder

public static VolumeBackupSchedule.Builder builder()

Create a new builder.

toBuilder

public VolumeBackupSchedule.Builder toBuilder()

getBackupType

public VolumeBackupSchedule.BackupType getBackupType()

The type of volume backup to create.

Returns:

the value

getOffsetSeconds

public Integer getOffsetSeconds()

The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period.

The volume backup start time is the frequency start time plus the offset.

Returns:

the value

getPeriod

public VolumeBackupSchedule.Period getPeriod()

The volume backup frequency.

Returns:

the value

getOffsetType

public VolumeBackupSchedule.OffsetType getOffsetType()

Indicates how the offset is defined.

If value is STRUCTURED, then hourOfDay, dayOfWeek, dayOfMonth, and month fields are used and offsetSeconds will be ignored in requests and users should ignore its value from the responses.

hourOfDay is applicable for periods ONE_DAY, ONE_WEEK, ONE_MONTH and ONE_YEAR.

dayOfWeek is applicable for period ONE_WEEK.

dayOfMonth is applicable for periods ONE_MONTH and ONE_YEAR.

'month' is applicable for period 'ONE_YEAR'.

They will be ignored in the requests for inapplicable periods.

If value is NUMERIC_SECONDS, then offsetSeconds will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses.

For clients using older versions of Apis and not sending offsetType in their requests, the behaviour is just like NUMERIC_SECONDS.

Returns:

the value

getHourOfDay

public Integer getHourOfDay()

The hour of the day to schedule the volume backup.

Returns:

the value

getDayOfWeek

public VolumeBackupSchedule.DayOfWeek getDayOfWeek()

The day of the week to schedule the volume backup.

Returns:

the value

getDayOfMonth

public Integer getDayOfMonth()

The day of the month to schedule the volume backup.

Returns:

the value

getMonth

public VolumeBackupSchedule.Month getMonth()

The month of the year to schedule the volume backup.

Returns:

the value

getRetentionSeconds

public Integer getRetentionSeconds()

How long, in seconds, to keep the volume backups created by this schedule.

Returns:

the value

getTimeZone

public VolumeBackupSchedule.TimeZone getTimeZone()

Specifies what time zone is the schedule in

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