/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * Defines the backup frequency and retention period for a volume backup policy. For more information, * see [Policy-Based Backups](https://docs.oracle.com/iaas/Content/Block/Tasks/schedulingvolumebackups.htm). * */ export interface VolumeBackupSchedule { /** * The type of volume backup to create. */ "backupType": VolumeBackupSchedule.BackupType; /** * 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. * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "offsetSeconds"?: number; /** * The volume backup frequency. */ "period": VolumeBackupSchedule.Period; /** * Indicates how the offset is defined. If value is {@code STRUCTURED}, * then {@code hourOfDay}, {@code dayOfWeek}, {@code dayOfMonth}, and {@code month} fields are used * and {@code offsetSeconds} will be ignored in requests and users should ignore its * value from the responses. *

{@code hourOfDay} is applicable for periods {@code ONE_DAY}, * {@code ONE_WEEK}, {@code ONE_MONTH} and {@code ONE_YEAR}. *

{@code dayOfWeek} is applicable for period * {@code ONE_WEEK}. *

{@code dayOfMonth} is applicable for periods {@code ONE_MONTH} and {@code ONE_YEAR}. *

'month' is applicable for period 'ONE_YEAR'. *

They will be ignored in the requests for inapplicable periods. *

If value is {@code NUMERIC_SECONDS}, then {@code 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 {@code offsetType} in their * requests, the behaviour is just like {@code NUMERIC_SECONDS}. * */ "offsetType"?: VolumeBackupSchedule.OffsetType; /** * The hour of the day to schedule the volume backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "hourOfDay"?: number; /** * The day of the week to schedule the volume backup. */ "dayOfWeek"?: VolumeBackupSchedule.DayOfWeek; /** * The day of the month to schedule the volume backup. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "dayOfMonth"?: number; /** * The month of the year to schedule the volume backup. */ "month"?: VolumeBackupSchedule.Month; /** * How long, in seconds, to keep the volume backups created by this schedule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "retentionSeconds": number; /** * Specifies what time zone is the schedule in */ "timeZone"?: VolumeBackupSchedule.TimeZone; "retentionPeriod"?: model.RetentionDuration; /** * Prevent backups from being deleted during the configured retention period. This is an optional field. If it is not specified, it is set to null, prevent deletion will not be applied to the backups. */ "isPreventDeletionEnabled"?: boolean; /** * feature that prevents deletion or alteration of backup data for a specified period to ensure data protection and regulatory compliance. This is an optional field. If it is not specified, it is set to null, no retention lock will be applied to the backups. This feature should be used in conjunction with the retention-period field. */ "isRetentionLockEnabled"?: boolean; } export declare namespace VolumeBackupSchedule { enum BackupType { Full = "FULL", Incremental = "INCREMENTAL", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum Period { OneHour = "ONE_HOUR", OneDay = "ONE_DAY", OneWeek = "ONE_WEEK", OneMonth = "ONE_MONTH", OneYear = "ONE_YEAR", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum OffsetType { Structured = "STRUCTURED", NumericSeconds = "NUMERIC_SECONDS", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum DayOfWeek { Monday = "MONDAY", Tuesday = "TUESDAY", Wednesday = "WEDNESDAY", Thursday = "THURSDAY", Friday = "FRIDAY", Saturday = "SATURDAY", Sunday = "SUNDAY", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum Month { January = "JANUARY", February = "FEBRUARY", March = "MARCH", April = "APRIL", May = "MAY", June = "JUNE", July = "JULY", August = "AUGUST", September = "SEPTEMBER", October = "OCTOBER", November = "NOVEMBER", December = "DECEMBER", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum TimeZone { Utc = "UTC", RegionalDataCenterTime = "REGIONAL_DATA_CENTER_TIME", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: VolumeBackupSchedule): object; function getDeserializedJsonObj(obj: VolumeBackupSchedule): object; }