Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateScheduledJobDetails

Provides the information used to create a scheduled job.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the scheduled job.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

User-specified description of the scheduled job. Avoid entering confidential information.

Optional displayName

displayName: undefined | string

User-friendly name for the scheduled job. Does not have to be unique and you can change the name later. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

Optional isManagedByAutonomousLinux

isManagedByAutonomousLinux: undefined | false | true

Indicates whether this scheduled job is managed by the Autonomous Linux service.

Optional isSubcompartmentIncluded

isSubcompartmentIncluded: undefined | false | true

Indicates whether to apply the scheduled job to all compartments in the tenancy when managedCompartmentIds specifies the tenancy OCID (root compartment).

Optional lifecycleStageIds

lifecycleStageIds: Array<string>

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.

Optional locations

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.

Optional managedCompartmentIds

managedCompartmentIds: Array<string>

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.

Optional managedInstanceGroupIds

managedInstanceGroupIds: Array<string>

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.

Optional managedInstanceIds

managedInstanceIds: Array<string>

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.

operations

operations: Array<ScheduledJobOperation>

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

Optional recurringRule

recurringRule: undefined | string

The frequency schedule for a recurring scheduled job.

Optional retryIntervals

retryIntervals: Array<number>

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.

scheduleType

scheduleType: ScheduleTypes

The type of scheduling frequency for the scheduled job.

timeNextExecution

timeNextExecution: Date

The desired time of the next execution of this scheduled job (in RFC 3339 format).

Functions

getDeserializedJsonObj

getJsonObj