Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SchedulerDefinition

Definition of a Schedule.

Properties

Optional actionGroupTypes

actionGroupTypes: Array<ActionGroupTypes>

All ActionGroup Types part of the schedule.

Optional actionGroups

actionGroups: Array<ActionGroup>

Action Groups associated with the Schedule.

Optional activityInitiationCutOff

activityInitiationCutOff: undefined | number

Activity Initiation Cut Off Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional applicationTypes

applicationTypes: Array<string>

All application types part of the schedule for ENVIRONMENT ActionGroup Type.

compartmentId

compartmentId: string

Tenancy OCID

Optional countOfAffectedActionGroups

countOfAffectedActionGroups: undefined | number

Count of Action Groups affected by the Schedule. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional countOfAffectedResources

countOfAffectedResources: undefined | number

Count of Resources affected by the Schedule Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional countOfAffectedTargets

countOfAffectedTargets: undefined | number

Count of Targets affected by the Schedule Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Example: {@code My new resource}

Optional freeformTags

freeformTags: undefined | object

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

id

id: string

The OCID of the resource.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Optional lifecycleOperations

lifecycleOperations: Array<string>

All LifeCycle Operations part of the schedule

lifecycleState

lifecycleState: LifecycleState

The current state of the SchedulerDefinition.

Optional products

products: Array<string>

All products part of the schedule for PRODUCT ActionGroup Type.

Optional resourceRegion

resourceRegion: undefined | string

Associated region

Optional runBooks

Runbooks.

Optional schedule

schedule: model.Schedule

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 resource was created. An RFC3339 formatted datetime string.

Optional timeOfNextRun

timeOfNextRun: Date

Scheduled date for the next run of the Job.

Optional timeUpdated

timeUpdated: Date

The time this resource was last updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj