scheduling_windows

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

Overview

Name	scheduling_windows
Type	Resource
Id	oci.database.scheduling_windows

Fields

The following fields are returned by SELECT queries:

get

The Scheduling Window details.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window.
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 user-friendly name for the Scheduling Window. The name does not need to be unique.
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"}
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Scheduling Window. Valid states are CREATING, ACTIVE, UPDATING, FAILED, DELETING and DELETED. (CREATING, AVAILABLE, UPDATING, FAILED, DELETING, DELETED)
schedulingPolicyId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
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 Window was created.
timeNextSchedulingWindowStarts	string (date-time)	The date and time of the next upcoming window associated within the schedulingWindow is planned to start.
timeUpdated	string (date-time)	The last date and time that the Scheduling Window was updated.
windowPreference	object	The Single Scheduling Window details.

list

Details of a Scheduling Window.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Window.
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 user-friendly name for the Scheduling Window. The name does not need to be unique.
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"}
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Scheduling Window. Valid states are CREATING, ACTIVE, UPDATING, FAILED, DELETING and DELETED. (CREATING, AVAILABLE, UPDATING, FAILED, DELETING, DELETED)
schedulingPolicyId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Scheduling Policy.
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 Window was created.
timeNextSchedulingWindowStarts	string (date-time)	The date and time of the next upcoming window associated within the schedulingWindow is planned to start.
timeUpdated	string (date-time)	The last date and time that the Scheduling Window was updated.
windowPreference	object	The Single Scheduling Window details.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	schedulingPolicyId, schedulingWindowId, region	opc-request-id	Gets information about the specified Scheduling Window.<br />
list	select	schedulingPolicyId, region	compartmentId, limit, page, opc-request-id, sortBy, sortOrder, lifecycleState, displayName	Lists the Scheduling Window resources in the specified compartment.<br />
create	insert	schedulingPolicyId, region, windowPreference	opc-retry-token, opc-request-id	Creates a Scheduling Window resource.<br />
update	update	schedulingPolicyId, schedulingWindowId, region	if-match, opc-request-id	Updates the Scheduling Window resource.<br />
delete	delete	schedulingPolicyId, schedulingWindowId, region	if-match, opc-request-id	Deletes the scheduling window.<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
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)
schedulingPolicyId	string	The Scheduling Policy [OCID](/Content/General/Concepts/identifiers.htm).
schedulingWindowId	string	The Scheduling Window [OCID](/Content/General/Concepts/identifiers.htm).
compartmentId	string	The compartment [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.
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.
sortBy	string	The 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.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

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

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
schedulingPolicyId,
systemTags,
timeCreated,
timeNextSchedulingWindowStarts,
timeUpdated,
windowPreference
FROM oci.database.scheduling_windows
WHERE schedulingPolicyId = '{{ schedulingPolicyId }}' -- required
AND schedulingWindowId = '{{ schedulingWindowId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

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

SELECT
id,
compartmentId,
definedTags,
displayName,
freeformTags,
lifecycleDetails,
lifecycleState,
schedulingPolicyId,
systemTags,
timeCreated,
timeNextSchedulingWindowStarts,
timeUpdated,
windowPreference
FROM oci.database.scheduling_windows
WHERE schedulingPolicyId = '{{ schedulingPolicyId }}' -- required
AND region = '{{ region }}' -- required
AND compartmentId = '{{ compartmentId }}'
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 }}'
;

INSERT examples

create

Creates a Scheduling Window resource.<br />

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

Manifest

# Description fields are for documentation purposes
- name: scheduling_windows
props:
  - name: schedulingPolicyId
    value: "{{ schedulingPolicyId }}"
    description: Required parameter for the scheduling_windows resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the scheduling_windows 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: windowPreference
    description: |
      The Single Scheduling Window details.
    value:
      daysOfWeek:
        - name: "{{ name }}"
      duration: {{ duration }}
      isEnforcedDuration: {{ isEnforcedDuration }}
      months:
        - name: "{{ name }}"
      startTime: "{{ startTime }}"
      weeksOfMonth:
        - {{ weeksOfMonth }}
  - 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. 

UPDATE examples

update

Updates the Scheduling Window resource.<br />

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

DELETE examples

delete

Deletes the scheduling window.<br />

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