Package com.oracle.bmc.core.model

Class VolumeBackupPolicy

java.lang.Object

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

com.oracle.bmc.core.model.VolumeBackupPolicy

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

A policy for automatically creating volume backups according to a recurring schedule.

Has a set of one or more schedules that control when and how backups are created.

*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the VolumeBackupPolicy.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 VolumeBackupPolicy.Builder, which maintain a set of all explicitly set fields called VolumeBackupPolicy.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	VolumeBackupPolicy.Builder

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
VolumeBackupPolicy(String displayName, String id, List<VolumeBackupSchedule> schedules, String destinationRegion, Date timeCreated, String compartmentId, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static VolumeBackupPolicy.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment that contains the volume backup.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDestinationRegion()	The paired destination region for copying scheduled backups to.
String	getDisplayName()	A user-friendly name.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
String	getId()	The OCID of the volume backup policy.
List<VolumeBackupSchedule>	getSchedules()	The collection of schedules that this policy will apply.
Date	getTimeCreated()	The date and time the volume backup policy was created.
int	hashCode()
VolumeBackupPolicy.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

VolumeBackupPolicy

@Deprecated
@ConstructorProperties({"displayName","id","schedules","destinationRegion","timeCreated","compartmentId","definedTags","freeformTags"})
public VolumeBackupPolicy(String displayName,
                          String id,
                          List<VolumeBackupSchedule> schedules,
                          String destinationRegion,
                          Date timeCreated,
                          String compartmentId,
                          Map<String,Map<String,Object>> definedTags,
                          Map<String,String> freeformTags)

Deprecated.

Method Detail

builder

public static VolumeBackupPolicy.Builder builder()

Create a new builder.

toBuilder

public VolumeBackupPolicy.Builder toBuilder()

getDisplayName

public String getDisplayName()

A user-friendly name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getId

public String getId()

The OCID of the volume backup policy.

Returns:

the value

getSchedules

public List<VolumeBackupSchedule> getSchedules()

The collection of schedules that this policy will apply.

Returns:

the value

getDestinationRegion

public String getDestinationRegion()

The paired destination region for copying scheduled backups to.

Example us-ashburn-1. See Region Pairs for details about paired regions.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the volume backup policy was created.

Format defined by RFC3339.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the volume backup.

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

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