Package com.oracle.bmc.loganalytics.model

Class PurgeAction

java.lang.Object

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

com.oracle.bmc.loganalytics.model.Action

com.oracle.bmc.loganalytics.model.PurgeAction

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class PurgeAction
extends Action

Purge action for scheduled task.
Note: Objects should always be created or deserialized using the PurgeAction.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 PurgeAction.Builder, which maintain a set of all explicitly set fields called PurgeAction.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	PurgeAction.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.loganalytics.model.Action

Action.Type

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
PurgeAction(String queryString, StorageDataType dataType, String purgeDuration, String purgeCompartmentId, Boolean compartmentIdInSubtree)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static PurgeAction.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Boolean	getCompartmentIdInSubtree()	if true, purge child compartments data
StorageDataType	getDataType()	the type of the log data to be purged
String	getPurgeCompartmentId()	the compartment OCID under which the data will be purged
String	getPurgeDuration()	The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires.
String	getQueryString()	Purge query string.
int	hashCode()
PurgeAction.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

PurgeAction

@Deprecated
public PurgeAction(String queryString,
                   StorageDataType dataType,
                   String purgeDuration,
                   String purgeCompartmentId,
                   Boolean compartmentIdInSubtree)

Deprecated.

Method Detail

builder

public static PurgeAction.Builder builder()

Create a new builder.

toBuilder

public PurgeAction.Builder toBuilder()

getQueryString

public String getQueryString()

Purge query string.

Returns:

the value

getDataType

public StorageDataType getDataType()

the type of the log data to be purged

Returns:

the value

getPurgeDuration

public String getPurgeDuration()

The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires.

The value should be negative. Purge duration in ISO 8601 extended format as described in https://en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).

Returns:

the value

getPurgeCompartmentId

public String getPurgeCompartmentId()

the compartment OCID under which the data will be purged

Returns:

the value

getCompartmentIdInSubtree

public Boolean getCompartmentIdInSubtree()

if true, purge child compartments data

Returns:

the value

toString

public String toString()

Overrides:

toString in class Action

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Action

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Action

hashCode

public int hashCode()

Overrides:

hashCode in class Action