Skip to main content

scheduling_policies

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

Overview​

Namescheduling_policies
TypeResource
Idoci.database.scheduling_policies

Fields​

The following fields are returned by SELECT queries:

The Scheduling Policy details.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
cadencestringThe cadence period. (HALFYEARLY, QUARTERLY, MONTHLY)
cadenceStartMonthobjectMonth of the year.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
displayNamestringThe user-friendly name for the Scheduling Policy. The name does not need to be unique.
freeformTagsobjectFree-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"}
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the Scheduling Policy. Valid states are CREATING, NEEDS_ATTENTION, ACTIVE, UPDATING, FAILED, DELETING and DELETED. (CREATING, NEEDS_ATTENTION, AVAILABLE, UPDATING, FAILED, DELETING, DELETED)
systemTagsobjectSystem tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreatedstring (date-time)The date and time the Scheduling Policy was created.
timeNextWindowStartsstring (date-time)The date and time of the next scheduling window associated with the schedulingPolicy is planned to start.
timeUpdatedstring (date-time)The last date and time that the Scheduling Policy was updated.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectschedulingPolicyId, regionopc-request-idGets information about the specified Scheduling Policy.<br />
listselectcompartmentId, regionlimit, page, opc-request-id, sortBy, sortOrder, lifecycleState, displayName, cadenceLists the Scheduling Policy resources in the specified compartment.<br />
createinsertregion, compartmentId, displayName, cadenceopc-retry-token, opc-request-idCreates a Scheduling Policy resource.<br />
updateupdateschedulingPolicyId, regionif-match, opc-request-idUpdates the Scheduling Policy resource.<br />
deletedeleteschedulingPolicyId, regionif-match, opc-request-idDeletes the scheduling policy.<br />
change_compartmentexecschedulingPolicyId, region, compartmentIdif-match, opc-request-id, opc-retry-tokenMoves an scheduling policy resource to another compartment.<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.

NameDatatypeDescription
compartmentIdstringThe compartment [OCID](/Content/General/Concepts/identifiers.htm).
regionstringOCI 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)
schedulingPolicyIdstringThe Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm).
cadencestringA filter to return only resources that match the given cadence period exactly.
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
if-matchstringFor 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.
lifecycleStatestringA filter to return only resources that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
opc-retry-tokenstringA 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).
pagestringThe pagination token to continue listing from.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples​

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

SELECT
id,
cadence,
cadenceStartMonth,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
systemTags,
timeCreated,
timeNextWindowStarts,
timeUpdated
FROM oci.database.scheduling_policies
WHERE schedulingPolicyId = '{{ schedulingPolicyId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates a Scheduling Policy resource.<br />

INSERT INTO oci.database.scheduling_policies (
cadence,
cadenceStartMonth,
compartmentId,
definedTags,
displayName,
freeformTags,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ cadence }}' /* required */,
'{{ cadenceStartMonth }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ displayName }}' /* required */,
'{{ freeformTags }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
cadence,
cadenceStartMonth,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
systemTags,
timeCreated,
timeNextWindowStarts,
timeUpdated
;

UPDATE examples​

Updates the Scheduling Policy resource.<br />

UPDATE oci.database.scheduling_policies
SET 
cadence = '{{ cadence }}',
cadenceStartMonth = '{{ cadenceStartMonth }}',
definedTags = '{{ definedTags }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}'
WHERE 
schedulingPolicyId = '{{ schedulingPolicyId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
cadence,
cadenceStartMonth,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
systemTags,
timeCreated,
timeNextWindowStarts,
timeUpdated;

DELETE examples​

Deletes the scheduling policy.<br />

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

Lifecycle Methods​

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

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