scheduling_plans

Creates, updates, deletes, gets or lists a scheduling_plans resource.

Overview

Name	scheduling_plans
Type	Resource
Id	oci.database.scheduling_plans

Fields

The following fields are returned by SELECT queries:

get

The Scheduling Plan details.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayName	string	The display name of the Scheduling Plan.
estimatedTimeInMins	integer	The estimated time for the Scheduling Plan.
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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isUsingRecommendedScheduledActions	boolean	If true, recommended scheduled actions will be generated for the scheduling plan.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. (CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING, DELETED)
planIntent	string	The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. (EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE) (default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE)
resourceId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.
schedulingPolicyId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
serviceType	string	The service type of the Scheduling Plan. (EXACC, EXACS, FPPPCS)
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time the Scheduling Plan Resource was created.
timeUpdated	string (date-time)	The date and time the Scheduling Plan Resource was updated.

list

A list of the Scheduling Plan resources in the specified compartment.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Plan.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayName	string	The display name of the Scheduling Plan.
estimatedTimeInMins	integer	The estimated time for the Scheduling Plan.
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](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
isUsingRecommendedScheduledActions	boolean	If true, recommended scheduled actions will be generated for the scheduling plan.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Scheduling Plan. Valid states are CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING and DELETED. (CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING, DELETED)
planIntent	string	The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE. (EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE, EXADATA_INFRASTRUCTURE_SECURITY_UPDATE) (default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE)
resourceId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.
schedulingPolicyId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
serviceType	string	The service type of the Scheduling Plan. (EXACC, EXACS, FPPPCS)
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time the Scheduling Plan Resource was created.
timeUpdated	string (date-time)	The date and time the Scheduling Plan Resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	schedulingPlanId, region	opc-request-id	Gets information about the specified Scheduling Plan.<br />
list	select	compartmentId, region	limit, page, opc-request-id, sortBy, sortOrder, lifecycleState, displayName, resourceId, id, planIntent	Lists the Scheduling Plan resources in the specified compartment.<br />
create	insert	region, schedulingPolicyId, resourceId, compartmentId, serviceType	opc-retry-token, opc-request-id	Creates a Scheduling Plan resource.<br />
delete	delete	schedulingPlanId, region	if-match, opc-request-id	Deletes the scheduling plan.<br />
change_compartment	exec	schedulingPlanId, region, compartmentId	if-match, opc-request-id, opc-retry-token	Moves an scheduling plan resource to another compartment.<br />
reorder_scheduled_actions	exec	schedulingPlanId, region, scheduledActionIdOrders	opc-retry-token, opc-request-id, if-match	Re-order the scheduled actions under this scheduling plan resource.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
schedulingPlanId	string	The Schedule Plan [OCID](/Content/General/Concepts/identifiers.htm).
displayName	string	A filter to return only resources that match the entire display name given. The match is not case sensitive.
id	string	A filter to return only resources that match the given Schedule Plan id exactly.
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter to return only resources that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The pagination token to continue listing from.
planIntent	string	A filter to return only resources that match the given plan intent exactly.
resourceId	string	A filter to return only resources that match the given resource id exactly.
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Gets information about the specified Scheduling Plan.<br />

SELECT
id,
compartmentId,
definedTags,
displayName,
estimatedTimeInMins,
freeformTags,
isUsingRecommendedScheduledActions,
lifecycleDetails,
lifecycleState,
planIntent,
resourceId,
schedulingPolicyId,
serviceType,
systemTags,
timeCreated,
timeUpdated
FROM oci.database.scheduling_plans
WHERE schedulingPlanId = '{{ schedulingPlanId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the Scheduling Plan resources in the specified compartment.<br />

SELECT
id,
compartmentId,
definedTags,
displayName,
estimatedTimeInMins,
freeformTags,
isUsingRecommendedScheduledActions,
lifecycleDetails,
lifecycleState,
planIntent,
resourceId,
schedulingPolicyId,
serviceType,
systemTags,
timeCreated,
timeUpdated
FROM oci.database.scheduling_plans
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND opc-request-id = '{{ opc-request-id }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
AND resourceId = '{{ resourceId }}'
AND id = '{{ id }}'
AND planIntent = '{{ planIntent }}'
;

INSERT examples

create

Creates a Scheduling Plan resource.<br />

INSERT INTO oci.database.scheduling_plans (
compartmentId,
definedTags,
freeformTags,
isUsingRecommendedScheduledActions,
planIntent,
resourceId,
schedulingPolicyId,
serviceType,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ freeformTags }}',
{{ isUsingRecommendedScheduledActions }},
'{{ planIntent }}',
'{{ resourceId }}' /* required */,
'{{ schedulingPolicyId }}' /* required */,
'{{ serviceType }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
compartmentId,
definedTags,
displayName,
estimatedTimeInMins,
freeformTags,
isUsingRecommendedScheduledActions,
lifecycleDetails,
lifecycleState,
planIntent,
resourceId,
schedulingPolicyId,
serviceType,
systemTags,
timeCreated,
timeUpdated
;

Manifest

# Description fields are for documentation purposes
- name: scheduling_plans
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the scheduling_plans resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: isUsingRecommendedScheduledActions
    value: {{ isUsingRecommendedScheduledActions }}
    description: |
      If true, recommended scheduled actions will be generated for the scheduling plan.
  - name: planIntent
    value: "{{ planIntent }}"
    description: |
      The current intent of the Scheduling Plan. Valid states are EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE and EXADATA_INFRASTRUCTURE_SECURITY_UPDATE.
    valid_values: ['EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE', 'EXADATA_INFRASTRUCTURE_SECURITY_UPDATE']
    default: EXADATA_INFRASTRUCTURE_FULL_SOFTWARE_UPDATE
  - name: resourceId
    value: "{{ resourceId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.
  - name: schedulingPolicyId
    value: "{{ schedulingPolicyId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
  - name: serviceType
    value: "{{ serviceType }}"
    description: |
      The service type of the Scheduling Plan.
    valid_values: ['EXACC', 'EXACS', 'FPPPCS']
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

DELETE examples

delete

Deletes the scheduling plan.<br />

DELETE FROM oci.database.scheduling_plans
WHERE schedulingPlanId = '{{ schedulingPlanId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;

Lifecycle Methods

change_compartment

Moves an scheduling plan resource to another compartment.<br />

EXEC oci.database.scheduling_plans.change_compartment 
@schedulingPlanId='{{ schedulingPlanId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

reorder_scheduled_actions

Re-order the scheduled actions under this scheduling plan resource.<br />

EXEC oci.database.scheduling_plans.reorder_scheduled_actions 
@schedulingPlanId='{{ schedulingPlanId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"scheduledActionIdOrders": "{{ scheduledActionIdOrders }}"
}'
;