Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ScheduledJobSummary

Provides summary information for a scheduled job.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the scheduled job.

definedTags

definedTags: 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"}}}

Type declaration

  • [key: string]: object
    • [key: string]: any

displayName

displayName: string

User-friendly name for the scheduled job.

freeformTags

freeformTags: 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"}}

Type declaration

  • [key: string]: string

id

id: string

The OCID of the scheduled job.

Optional isManagedByAutonomousLinux

isManagedByAutonomousLinux: undefined | false | true

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

Optional isRestricted

isRestricted: undefined | false | true

Indicates if the schedule job has restricted update and deletion capabilities. For restricted scheduled jobs, you can update only the timeNextExecution, recurringRule, and tags.

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 this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and managedCompartmentIds.

lifecycleState

lifecycleState: string

The current state of the scheduled job.

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. A scheduled job can only operate on one type of target, therefore this parameter is mutually exclusive with managedInstanceIds, managedInstanceGroupIds, and 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 this parameter is mutually exclusive with managedInstanceIds, managedCompartmentIds, and 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 this parameter is mutually exclusive with managedInstanceGroupIds, managedCompartmentIds, and 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 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 this scheduled job follows.

Optional systemTags

systemTags: undefined | object

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

timeCreated

timeCreated: Date

The time this scheduled job was created (in RFC 3339 format).

Optional timeLastExecution

timeLastExecution: Date

The time of the last execution of this scheduled job (in RFC 3339 format).b.

timeNextExecution

timeNextExecution: Date

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

timeUpdated

timeUpdated: Date

The time this scheduled job was updated (in RFC 3339 format).

Functions

getDeserializedJsonObj

getJsonObj