Package com.oracle.bmc.core.model

Class VolumeBackupSchedule.Builder

java.lang.Object

com.oracle.bmc.core.model.VolumeBackupSchedule.Builder

Enclosing class:

VolumeBackupSchedule

public static class VolumeBackupSchedule.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
VolumeBackupSchedule.Builder	backupType(VolumeBackupSchedule.BackupType backupType)	The type of volume backup to create.
VolumeBackupSchedule	build()
VolumeBackupSchedule.Builder	copy(VolumeBackupSchedule model)
VolumeBackupSchedule.Builder	dayOfMonth(Integer dayOfMonth)	The day of the month to schedule the volume backup.
VolumeBackupSchedule.Builder	dayOfWeek(VolumeBackupSchedule.DayOfWeek dayOfWeek)	The day of the week to schedule the volume backup.
VolumeBackupSchedule.Builder	hourOfDay(Integer hourOfDay)	The hour of the day to schedule the volume backup.
VolumeBackupSchedule.Builder	month(VolumeBackupSchedule.Month month)	The month of the year to schedule the volume backup.
VolumeBackupSchedule.Builder	offsetSeconds(Integer offsetSeconds)	The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period.
VolumeBackupSchedule.Builder	offsetType(VolumeBackupSchedule.OffsetType offsetType)	Indicates how the offset is defined.
VolumeBackupSchedule.Builder	period(VolumeBackupSchedule.Period period)	The volume backup frequency.
VolumeBackupSchedule.Builder	retentionSeconds(Integer retentionSeconds)	How long, in seconds, to keep the volume backups created by this schedule.
VolumeBackupSchedule.Builder	timeZone(VolumeBackupSchedule.TimeZone timeZone)	Specifies what time zone is the schedule in

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

backupType

public VolumeBackupSchedule.Builder backupType(VolumeBackupSchedule.BackupType backupType)

The type of volume backup to create.

Parameters:

backupType - the value to set

Returns:

this builder

offsetSeconds

public VolumeBackupSchedule.Builder offsetSeconds(Integer offsetSeconds)

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.

Parameters:

offsetSeconds - the value to set

Returns:

this builder

period

public VolumeBackupSchedule.Builder period(VolumeBackupSchedule.Period period)

The volume backup frequency.

Parameters:

period - the value to set

Returns:

this builder

offsetType

public VolumeBackupSchedule.Builder offsetType(VolumeBackupSchedule.OffsetType offsetType)

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.

Parameters:

offsetType - the value to set

Returns:

this builder

hourOfDay

public VolumeBackupSchedule.Builder hourOfDay(Integer hourOfDay)

The hour of the day to schedule the volume backup.

Parameters:

hourOfDay - the value to set

Returns:

this builder

dayOfWeek

public VolumeBackupSchedule.Builder dayOfWeek(VolumeBackupSchedule.DayOfWeek dayOfWeek)

The day of the week to schedule the volume backup.

Parameters:

dayOfWeek - the value to set

Returns:

this builder

dayOfMonth

public VolumeBackupSchedule.Builder dayOfMonth(Integer dayOfMonth)

The day of the month to schedule the volume backup.

Parameters:

dayOfMonth - the value to set

Returns:

this builder

month

public VolumeBackupSchedule.Builder month(VolumeBackupSchedule.Month month)

The month of the year to schedule the volume backup.

Parameters:

month - the value to set

Returns:

this builder

retentionSeconds

public VolumeBackupSchedule.Builder retentionSeconds(Integer retentionSeconds)

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

Parameters:

retentionSeconds - the value to set

Returns:

this builder

timeZone

public VolumeBackupSchedule.Builder timeZone(VolumeBackupSchedule.TimeZone timeZone)

Specifies what time zone is the schedule in

Parameters:

timeZone - the value to set

Returns:

this builder

build

public VolumeBackupSchedule build()

copy

public VolumeBackupSchedule.Builder copy(VolumeBackupSchedule model)