@Generated(value="OracleSDKGenerator",
comments="API Version: 20220901")
public final class ScheduledJob
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The object that defines a scheduled job. For more information about jobs, see Managing
Jobs.
Note: Objects should always be created or deserialized using the ScheduledJob.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 ScheduledJob.Builder, which maintain a
set of all explicitly set fields called ScheduledJob.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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ScheduledJob.Builder |
static class |
ScheduledJob.LifecycleState
The current state of the scheduled job.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ScheduledJob(String id,
String displayName,
String compartmentId,
String description,
ScheduleTypes scheduleType,
List<ManagedInstanceLocation> locations,
Date timeNextExecution,
Date timeLastExecution,
String recurringRule,
List<String> managedInstanceIds,
List<String> managedInstanceGroupIds,
List<String> managedCompartmentIds,
List<String> lifecycleStageIds,
Boolean isSubcompartmentIncluded,
List<ScheduledJobOperation> operations,
List<String> workRequestIds,
Date timeCreated,
Date timeUpdated,
ScheduledJob.LifecycleState lifecycleState,
Boolean isManagedByAutonomousLinux,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags,
Boolean isRestricted,
List<Integer> retryIntervals)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ScheduledJob.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of
the compartment that contains the scheduled job.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
User-specified description for the scheduled job.
|
String |
getDisplayName()
User-friendly name for the scheduled job.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of
the scheduled job.
|
Boolean |
getIsManagedByAutonomousLinux()
Indicates whether this scheduled job is managed by the Autonomous Linux service.
|
Boolean |
getIsRestricted()
Indicates if the schedule job has restricted update and deletion capabilities.
|
Boolean |
getIsSubcompartmentIncluded()
Indicates whether to apply the scheduled job to all compartments in the tenancy when
managedCompartmentIds specifies the tenancy
OCID (root
compartment).
|
List<String> |
getLifecycleStageIds()
The lifecycle stage
OCIDs that
this scheduled job operates on.
|
ScheduledJob.LifecycleState |
getLifecycleState()
The current state of the scheduled job.
|
List<ManagedInstanceLocation> |
getLocations()
The list of locations this scheduled job should operate on for a job targeting on
compartments.
|
List<String> |
getManagedCompartmentIds()
The compartment
OCIDs that
this scheduled job operates on.
|
List<String> |
getManagedInstanceGroupIds()
The managed instance group
OCIDs that
this scheduled job operates on.
|
List<String> |
getManagedInstanceIds()
The managed instance
OCIDs that
this scheduled job operates on.
|
List<ScheduledJobOperation> |
getOperations()
The list of operations this scheduled job needs to perform.
|
String |
getRecurringRule()
The frequency schedule for a recurring scheduled job.
|
List<Integer> |
getRetryIntervals()
The amount of time in minutes to wait until retrying the scheduled job.
|
ScheduleTypes |
getScheduleType()
The type of scheduling frequency for the job.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
The time this scheduled job was created (in RFC 3339
format).
|
Date |
getTimeLastExecution()
The time of the last execution of this scheduled job (in RFC
3339 format).
|
Date |
getTimeNextExecution()
The time of the next execution of this scheduled job (in RFC
3339 format).
|
Date |
getTimeUpdated()
The time this scheduled job was updated (in RFC 3339
format).
|
List<String> |
getWorkRequestIds()
The list of work request
OCIDs
associated with this scheduled job.
|
int |
hashCode() |
ScheduledJob.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","description","scheduleType","locations","timeNextExecution","timeLastExecution","recurringRule","managedInstanceIds","managedInstanceGroupIds","managedCompartmentIds","lifecycleStageIds","isSubcompartmentIncluded","operations","workRequestIds","timeCreated","timeUpdated","lifecycleState","isManagedByAutonomousLinux","freeformTags","definedTags","systemTags","isRestricted","retryIntervals"}) public ScheduledJob(String id, String displayName, String compartmentId, String description, ScheduleTypes scheduleType, List<ManagedInstanceLocation> locations, Date timeNextExecution, Date timeLastExecution, String recurringRule, List<String> managedInstanceIds, List<String> managedInstanceGroupIds, List<String> managedCompartmentIds, List<String> lifecycleStageIds, Boolean isSubcompartmentIncluded, List<ScheduledJobOperation> operations, List<String> workRequestIds, Date timeCreated, Date timeUpdated, ScheduledJob.LifecycleState lifecycleState, Boolean isManagedByAutonomousLinux, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, Boolean isRestricted, List<Integer> retryIntervals)
public static ScheduledJob.Builder builder()
Create a new builder.
public ScheduledJob.Builder toBuilder()
public String getDisplayName()
User-friendly name for the scheduled job.
public String getCompartmentId()
The OCID of the compartment that contains the scheduled job.
public String getDescription()
User-specified description for the scheduled job.
public ScheduleTypes getScheduleType()
The type of scheduling frequency for the job.
public List<ManagedInstanceLocation> getLocations()
The list of locations this scheduled job should operate on for a job targeting on compartments. (Empty list means apply to all locations). This can only be set when managedCompartmentIds is not empty.
public Date getTimeNextExecution()
The time of the next execution of this scheduled job (in RFC 3339 format).
public Date getTimeLastExecution()
The time of the last execution of this scheduled job (in RFC 3339 format).
public String getRecurringRule()
The frequency schedule for a recurring scheduled job.
public List<String> getManagedInstanceIds()
The managed instance OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and lifecycleStageIds.
public List<String> getManagedInstanceGroupIds()
The managed instance group OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and lifecycleStageIds.
public List<String> getManagedCompartmentIds()
The compartment OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and lifecycleStageIds.
public List<String> getLifecycleStageIds()
The lifecycle stage OCIDs that this scheduled job operates on. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.
public Boolean getIsSubcompartmentIncluded()
Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).
public List<ScheduledJobOperation> getOperations()
The list of operations this scheduled job needs to perform. A scheduled job supports only one operation type, unless it is one of the following: * UPDATE_PACKAGES * UPDATE_ALL * UPDATE_SECURITY * UPDATE_BUGFIX * UPDATE_ENHANCEMENT * UPDATE_OTHER * UPDATE_KSPLICE_USERSPACE * UPDATE_KSPLICE_KERNEL
public List<String> getWorkRequestIds()
The list of work request OCIDs associated with this scheduled job.
public Date getTimeCreated()
The time this scheduled job was created (in RFC 3339 format).
public Date getTimeUpdated()
The time this scheduled job was updated (in RFC 3339 format).
public ScheduledJob.LifecycleState getLifecycleState()
The current state of the scheduled job.
public Boolean getIsManagedByAutonomousLinux()
Indicates whether this scheduled job is managed by the Autonomous Linux service.
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"}
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"}}
public Map<String,Map<String,Object>> getSystemTags()
System tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"orcl-cloud": {"free-tier-retained": "true"}}
public Boolean getIsRestricted()
Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.
public List<Integer> getRetryIntervals()
The amount of time in minutes to wait until retrying the scheduled job. If set, the service will automatically retry a failed scheduled job after the interval. For example, you could set the interval to [2,5,10]. If the initial execution of the job fails, the service waits 2 minutes and then retries. If that fails, the service waits 5 minutes and then retries. If that fails, the service waits 10 minutes and then retries.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.