com.oracle.bmc.loganalytics.model

Class ScheduledTask

java.lang.Object

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

com.oracle.bmc.loganalytics.model.ScheduledTask

Direct Known Subclasses:

StandardTask

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

Log analytics scheduled task resource.
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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	ScheduledTask.Kind Discriminator.
static class	ScheduledTask.LifecycleState The current state of the scheduled task.
static class	ScheduledTask.PauseReason reason for taskStatus PAUSED.
static class	ScheduledTask.TaskStatus Status of the scheduled task.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

ScheduledTask(String id, String displayName, TaskType taskType, List<Schedule> schedules, Action action, ScheduledTask.TaskStatus taskStatus, ScheduledTask.PauseReason pauseReason, String workRequestId, Long numOccurrences, String compartmentId, Date timeCreated, Date timeUpdated, Date timeOfNextExecution, ScheduledTask.LifecycleState lifecycleState, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Action	getAction()
String	getCompartmentId() Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name that is changeable and that does not have to be unique.
Map<String,String>	getFreeformTags() Simple key-value pair that is applied without any predefined name, type or scope.
String	getId() The OCID of the data plane resource.
ScheduledTask.LifecycleState	getLifecycleState() The current state of the scheduled task.
Long	getNumOccurrences() Number of execution occurrences.
ScheduledTask.PauseReason	getPauseReason() reason for taskStatus PAUSED.
List<Schedule>	getSchedules() Schedules.
ScheduledTask.TaskStatus	getTaskStatus() Status of the scheduled task.
TaskType	getTaskType() Task type.
Date	getTimeCreated() The date and time the scheduled task was created, in the format defined by RFC3339.
Date	getTimeOfNextExecution() The date and time the scheduled task will execute next, in the format defined by RFC3339.
Date	getTimeUpdated() The date and time the scheduled task was last updated, in the format defined by RFC3339.
String	getWorkRequestId() most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.
int	hashCode()
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

ScheduledTask

@Deprecated
 @ConstructorProperties(value={"id","displayName","taskType","schedules","action","taskStatus","pauseReason","workRequestId","numOccurrences","compartmentId","timeCreated","timeUpdated","timeOfNextExecution","lifecycleState","freeformTags","definedTags"})
protected ScheduledTask(String id,
                                                                                                                                                                                                                                                                                                    String displayName,
                                                                                                                                                                                                                                                                                                    TaskType taskType,
                                                                                                                                                                                                                                                                                                    List<Schedule> schedules,
                                                                                                                                                                                                                                                                                                    Action action,
                                                                                                                                                                                                                                                                                                    ScheduledTask.TaskStatus taskStatus,
                                                                                                                                                                                                                                                                                                    ScheduledTask.PauseReason pauseReason,
                                                                                                                                                                                                                                                                                                    String workRequestId,
                                                                                                                                                                                                                                                                                                    Long numOccurrences,
                                                                                                                                                                                                                                                                                                    String compartmentId,
                                                                                                                                                                                                                                                                                                    Date timeCreated,
                                                                                                                                                                                                                                                                                                    Date timeUpdated,
                                                                                                                                                                                                                                                                                                    Date timeOfNextExecution,
                                                                                                                                                                                                                                                                                                    ScheduledTask.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                    Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                    Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

getId

public String getId()

The OCID of the data plane resource.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name that is changeable and that does not have to be unique. Format: a leading alphanumeric, followed by zero or more alphanumerics, underscores, spaces, backslashes, or hyphens in any order). No trailing spaces allowed.

Returns:

the value

getTaskType

public TaskType getTaskType()

Task type.

Returns:

the value

getSchedules

public List<Schedule> getSchedules()

Schedules.

Returns:

the value

getAction

public Action getAction()

getTaskStatus

public ScheduledTask.TaskStatus getTaskStatus()

Status of the scheduled task.

Returns:

the value

getPauseReason

public ScheduledTask.PauseReason getPauseReason()

reason for taskStatus PAUSED.

Returns:

the value

getWorkRequestId

public String getWorkRequestId()

most recent Work Request Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the asynchronous request.

Returns:

the value

getNumOccurrences

public Long getNumOccurrences()

Number of execution occurrences.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the scheduled task was created, in the format defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the scheduled task was last updated, in the format defined by RFC3339.

Returns:

the value

getTimeOfNextExecution

public Date getTimeOfNextExecution()

The date and time the scheduled task will execute next, in the format defined by RFC3339.

Returns:

the value

getLifecycleState

public ScheduledTask.LifecycleState getLifecycleState()

The current state of the scheduled task.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

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. Example: {"foo-namespace": {"bar-key": "value"}}

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