@Generated(value="OracleSDKGenerator", comments="API Version: 20220901") public final class CreateScheduledJobDetails extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Provides the information used to create a scheduled job.
Note: Objects should always be created or deserialized using the CreateScheduledJobDetails.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 CreateScheduledJobDetails.Builder
, which maintain a
set of all explicitly set fields called CreateScheduledJobDetails.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 |
CreateScheduledJobDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
CreateScheduledJobDetails(String compartmentId,
String displayName,
String description,
ScheduleTypes scheduleType,
List<ManagedInstanceLocation> locations,
Date timeNextExecution,
String recurringRule,
List<String> managedInstanceIds,
List<String> managedInstanceGroupIds,
List<String> managedCompartmentIds,
List<String> lifecycleStageIds,
Boolean isSubcompartmentIncluded,
List<ScheduledJobOperation> operations,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
List<Integer> retryIntervals,
Boolean isManagedByAutonomousLinux)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static CreateScheduledJobDetails.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 of the scheduled job.
|
String |
getDisplayName()
User-friendly name for the scheduled job.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
Boolean |
getIsManagedByAutonomousLinux()
Indicates whether this scheduled job is managed by the Autonomous Linux service.
|
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.
|
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 scheduled job.
|
Date |
getTimeNextExecution()
The desired time of the next execution of this scheduled job (in RFC
3339 format).
|
int |
hashCode() |
CreateScheduledJobDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"compartmentId","displayName","description","scheduleType","locations","timeNextExecution","recurringRule","managedInstanceIds","managedInstanceGroupIds","managedCompartmentIds","lifecycleStageIds","isSubcompartmentIncluded","operations","freeformTags","definedTags","retryIntervals","isManagedByAutonomousLinux"}) public CreateScheduledJobDetails(String compartmentId, String displayName, String description, ScheduleTypes scheduleType, List<ManagedInstanceLocation> locations, Date timeNextExecution, String recurringRule, List<String> managedInstanceIds, List<String> managedInstanceGroupIds, List<String> managedCompartmentIds, List<String> lifecycleStageIds, Boolean isSubcompartmentIncluded, List<ScheduledJobOperation> operations, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, List<Integer> retryIntervals, Boolean isManagedByAutonomousLinux)
public static CreateScheduledJobDetails.Builder builder()
Create a new builder.
public CreateScheduledJobDetails.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment that contains the scheduled job.
public String getDisplayName()
User-friendly name for the scheduled job. Does not have to be unique and you can change the name later. Avoid entering confidential information.
public String getDescription()
User-specified description of the scheduled job. Avoid entering confidential information.
public ScheduleTypes getScheduleType()
The type of scheduling frequency for the scheduled 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 desired time of the next 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 you must supply either this or managedInstanceGroupIds, or managedCompartmentIds, or 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 you must supply either this or managedInstanceIds, or managedCompartmentIds, or lifecycleStageIds.
public List<String> getManagedCompartmentIds()
The compartment OCIDs that this scheduled job operates on. To apply the job to all compartments in the tenancy, set this to the tenancy OCID (root compartment) and set isSubcompartmentIncluded to true. A scheduled job can only operate on one type of target, therefore you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or 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 you must supply either this or managedInstanceIds, or managedInstanceGroupIds, or 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 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 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 Boolean getIsManagedByAutonomousLinux()
Indicates whether this scheduled job is managed by the Autonomous Linux service.
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public 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.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.