com.oracle.bmc.filestorage.model

Class SnapshotSchedule.Builder

java.lang.Object

com.oracle.bmc.filestorage.model.SnapshotSchedule.Builder

Enclosing class:

SnapshotSchedule

public static class SnapshotSchedule.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SnapshotSchedule	build()
SnapshotSchedule.Builder	copy(SnapshotSchedule model)
SnapshotSchedule.Builder	dayOfMonth(Integer dayOfMonth) The day of the month to create a scheduled snapshot.
SnapshotSchedule.Builder	dayOfWeek(SnapshotSchedule.DayOfWeek dayOfWeek) The day of the week to create a scheduled snapshot.
SnapshotSchedule.Builder	hourOfDay(Integer hourOfDay) The hour of the day to create a DAILY, WEEKLY, MONTHLY, or YEARLY snapshot.
SnapshotSchedule.Builder	month(SnapshotSchedule.Month month) The month to create a scheduled snapshot.
SnapshotSchedule.Builder	period(SnapshotSchedule.Period period) The frequency of scheduled snapshots.
SnapshotSchedule.Builder	retentionDurationInSeconds(Long retentionDurationInSeconds) The number of seconds to retain snapshots created with this schedule.
SnapshotSchedule.Builder	schedulePrefix(String schedulePrefix) A name prefix to be applied to snapshots created by this schedule.
SnapshotSchedule.Builder	timeScheduleStart(Date timeScheduleStart) The starting point used to begin the scheduling of the snapshots based upon recurrence string in RFC 3339 timestamp format.
SnapshotSchedule.Builder	timeZone(SnapshotSchedule.TimeZone timeZone) Time zone used for scheduling the snapshot.

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

schedulePrefix

public SnapshotSchedule.Builder schedulePrefix(String schedulePrefix)

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

Example: compliance1

Parameters:

schedulePrefix - the value to set

Returns:

this builder

timeScheduleStart

public SnapshotSchedule.Builder timeScheduleStart(Date timeScheduleStart)

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.

Parameters:

timeScheduleStart - the value to set

Returns:

this builder

period

public SnapshotSchedule.Builder period(SnapshotSchedule.Period period)

The frequency of scheduled snapshots.

Parameters:

period - the value to set

Returns:

this builder

retentionDurationInSeconds

public SnapshotSchedule.Builder retentionDurationInSeconds(Long retentionDurationInSeconds)

The number of seconds to retain snapshots created with this schedule. Snapshot expiration time will not be set if this value is empty.

Parameters:

retentionDurationInSeconds - the value to set

Returns:

this builder

timeZone

public SnapshotSchedule.Builder timeZone(SnapshotSchedule.TimeZone timeZone)

Time zone used for scheduling the snapshot.

Parameters:

timeZone - the value to set

Returns:

this builder

hourOfDay

public SnapshotSchedule.Builder hourOfDay(Integer hourOfDay)

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.

Parameters:

hourOfDay - the value to set

Returns:

this builder

dayOfWeek

public SnapshotSchedule.Builder dayOfWeek(SnapshotSchedule.DayOfWeek dayOfWeek)

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.

Parameters:

dayOfWeek - the value to set

Returns:

this builder

dayOfMonth

public SnapshotSchedule.Builder dayOfMonth(Integer dayOfMonth)

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.

Parameters:

dayOfMonth - the value to set

Returns:

this builder

month

public SnapshotSchedule.Builder month(SnapshotSchedule.Month month)

The month to create a scheduled snapshot. Used only for YEARLY snapshot schedules. If not set, the system chooses a value at creation time.

Parameters:

month - the value to set

Returns:

this builder

build

public SnapshotSchedule build()

copy

public SnapshotSchedule.Builder copy(SnapshotSchedule model)