com.oracle.bmc.filestorage.model

Class FilesystemSnapshotPolicy

java.lang.Object

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

com.oracle.bmc.filestorage.model.FilesystemSnapshotPolicy

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

A file system snapshot policy is used to automate snapshot creation and deletion. It contains a list of snapshot schedules that define the frequency of snapshot creation for the associated file systems and the retention period of snapshots taken on schedule.

For more information, see [Snapshot Scheduling](https://docs.cloud.oracle.com/iaas/Content/File/Tasks/snapshot-policies-and-schedules.htm).

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the FilesystemSnapshotPolicy.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 FilesystemSnapshotPolicy.Builder, which maintain a set of all explicitly set fields called FilesystemSnapshotPolicy.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 and Description
static class	FilesystemSnapshotPolicy.Builder
static class	FilesystemSnapshotPolicy.LifecycleState The current state of the file system snapshot policy.

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 and Description
FilesystemSnapshotPolicy(String compartmentId, String availabilityDomain, String id, FilesystemSnapshotPolicy.LifecycleState lifecycleState, Date timeCreated, String displayName, String policyPrefix, List<SnapshotSchedule> schedules, List<ResourceLock> locks, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static FilesystemSnapshotPolicy.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getAvailabilityDomain() The availability domain that the file system snapshot policy is in.
String	getCompartmentId() The OCID of the compartment that contains the file system snapshot policy.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() The OCID of the file system snapshot policy.
FilesystemSnapshotPolicy.LifecycleState	getLifecycleState() The current state of the file system snapshot policy.
List<ResourceLock>	getLocks() Locks associated with this resource.
String	getPolicyPrefix() The prefix to apply to all snapshots created by this policy.
List<SnapshotSchedule>	getSchedules() The list of associated snapshot schedules.
Date	getTimeCreated() The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.
int	hashCode()
FilesystemSnapshotPolicy.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

FilesystemSnapshotPolicy

@Deprecated
 @ConstructorProperties(value={"compartmentId","availabilityDomain","id","lifecycleState","timeCreated","displayName","policyPrefix","schedules","locks","freeformTags","definedTags"})
public FilesystemSnapshotPolicy(String compartmentId,
                                                                                                                                                                                                                                    String availabilityDomain,
                                                                                                                                                                                                                                    String id,
                                                                                                                                                                                                                                    FilesystemSnapshotPolicy.LifecycleState lifecycleState,
                                                                                                                                                                                                                                    Date timeCreated,
                                                                                                                                                                                                                                    String displayName,
                                                                                                                                                                                                                                    String policyPrefix,
                                                                                                                                                                                                                                    List<SnapshotSchedule> schedules,
                                                                                                                                                                                                                                    List<ResourceLock> locks,
                                                                                                                                                                                                                                    Map<String,String> freeformTags,
                                                                                                                                                                                                                                    Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static FilesystemSnapshotPolicy.Builder builder()

Create a new builder.

toBuilder

public FilesystemSnapshotPolicy.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment that contains the file system snapshot policy.

Returns:

the value

getAvailabilityDomain

public String getAvailabilityDomain()

The availability domain that the file system snapshot policy is in. May be unset using a blank or NULL value.

Example: Uocm:PHX-AD-2

Returns:

the value

getId

public String getId()

The OCID of the file system snapshot policy.

Returns:

the value

getLifecycleState

public FilesystemSnapshotPolicy.LifecycleState getLifecycleState()

The current state of the file system snapshot policy.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the file system snapshot policy was created, expressed in RFC 3339 timestamp format.

Example: 2016-08-25T21:10:29.600Z

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: policy1

Returns:

the value

getPolicyPrefix

public String getPolicyPrefix()

The prefix to apply to all snapshots created by this policy.

Example: acme

Returns:

the value

getSchedules

public List<SnapshotSchedule> getSchedules()

The list of associated snapshot schedules. A maximum of 10 schedules can be associated with a policy.

Returns:

the value

getLocks

public List<ResourceLock> getLocks()

Locks associated with this resource.

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

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

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