Package com.oracle.bmc.objectstorage.model

Class ObjectLifecycleRule

java.lang.Object

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

com.oracle.bmc.objectstorage.model.ObjectLifecycleRule

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

To use any of the API operations, you must be authorized in an IAM policy.

If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.
Note: Objects should always be created or deserialized using the ObjectLifecycleRule.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 ObjectLifecycleRule.Builder, which maintain a set of all explicitly set fields called ObjectLifecycleRule.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	ObjectLifecycleRule.Builder
static class	ObjectLifecycleRule.TimeUnit	The unit that should be used to interpret timeAmount.

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
ObjectLifecycleRule(String name, String target, String action, Long timeAmount, ObjectLifecycleRule.TimeUnit timeUnit, Boolean isEnabled, ObjectNameFilter objectNameFilter)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ObjectLifecycleRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAction()	The action of the object lifecycle policy rule.
Boolean	getIsEnabled()	A Boolean that determines whether this rule is currently enabled.
String	getName()	The name of the lifecycle rule to be applied.
ObjectNameFilter	getObjectNameFilter()
String	getTarget()	The target of the object lifecycle policy rule.
Long	getTimeAmount()	Specifies the age of objects to apply the rule to.
ObjectLifecycleRule.TimeUnit	getTimeUnit()	The unit that should be used to interpret timeAmount.
int	hashCode()
ObjectLifecycleRule.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

ObjectLifecycleRule

@Deprecated
@ConstructorProperties({"name","target","action","timeAmount","timeUnit","isEnabled","objectNameFilter"})
public ObjectLifecycleRule(String name,
                           String target,
                           String action,
                           Long timeAmount,
                           ObjectLifecycleRule.TimeUnit timeUnit,
                           Boolean isEnabled,
                           ObjectNameFilter objectNameFilter)

Deprecated.

Method Detail

builder

public static ObjectLifecycleRule.Builder builder()

Create a new builder.

toBuilder

public ObjectLifecycleRule.Builder toBuilder()

getName

public String getName()

The name of the lifecycle rule to be applied.

Returns:

the value

getTarget

public String getTarget()

The target of the object lifecycle policy rule.

The values of target can be either “objects”, “multipart-uploads” or “previous-object-versions”. This field when declared as “objects” is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for objects. This field when declared as “previous-object-versions” is used to specify ARCHIVE, INFREQUENT_ACCESS or DELETE rule for previous versions of existing objects. This field when declared as “multipart-uploads” is used to specify the ABORT (only) rule for uncommitted multipart-uploads.

Returns:

the value

getAction

public String getAction()

The action of the object lifecycle policy rule.

Rules using the action ‘ARCHIVE’ move objects from Standard and InfrequentAccess storage tiers into the Archive storage tier. Rules using the action ‘INFREQUENT_ACCESS’ move objects from Standard storage tier into the Infrequent Access Storage tier. Objects that are already in InfrequentAccess tier or in Archive tier are left untouched. Rules using the action ‘DELETE’ permanently delete objects from buckets. Rules using ‘ABORT’ abort the uncommitted multipart-uploads and permanently delete their parts from buckets.

Returns:

the value

getTimeAmount

public Long getTimeAmount()

Specifies the age of objects to apply the rule to.

The timeAmount is interpreted in units defined by the timeUnit parameter, and is calculated in relation to each object’s Last-Modified time.

Returns:

the value

getTimeUnit

public ObjectLifecycleRule.TimeUnit getTimeUnit()

The unit that should be used to interpret timeAmount.

Days are defined as starting and ending at midnight UTC. Years are defined as 365.2425 days long and likewise round up to the next midnight UTC.

Returns:

the value

getIsEnabled

public Boolean getIsEnabled()

A Boolean that determines whether this rule is currently enabled.

Returns:

the value

getObjectNameFilter

public ObjectNameFilter getObjectNameFilter()

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