execution_windows

Creates, updates, deletes, gets or lists an execution_windows resource.

Overview

Name	execution_windows
Type	Resource
Id	oci.database.execution_windows

Fields

The following fields are returned by SELECT queries:

get

The execution window details.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution 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).
description	string	Description of the execution window.
displayName	string	The user-friendly name for the execution window. The name does not need to be unique.
estimatedTimeInMins	integer	The estimated time of the execution window in minutes.
executionResourceId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to.
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"}
isEnforcedDuration	boolean	Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is FALSE.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Schedule Policy. Valid states are CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. (CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED, PARTIAL_SUCCESS)
lifecycleSubstate	string	The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. (DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS, WAITING)
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 execution window was created.
timeEnded	string (date-time)	The date and time that the execution window ended.
timeScheduled	string (date-time)	The scheduled start date and time of the execution window.
timeStarted	string (date-time)	The date and time that the execution window was started.
timeUpdated	string (date-time)	The last date and time that the execution window was updated.
windowDurationInMins	integer	Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes.
windowType	string	The execution window is of PLANNED or UNPLANNED type. (PLANNED, UNPLANNED)

list

Details of an execution window.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution 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).
description	string	Description of the execution window.
displayName	string	The user-friendly name for the execution window. The name does not need to be unique.
estimatedTimeInMins	integer	The estimated time of the execution window in minutes.
executionResourceId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to.
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"}
isEnforcedDuration	boolean	Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is FALSE.
lifecycleDetails	string	Additional information about the current lifecycle state.
lifecycleState	string	The current state of the Schedule Policy. Valid states are CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED and PARTIAL_SUCCESS. (CREATED, SCHEDULED, IN_PROGRESS, FAILED, CANCELED, UPDATING, DELETED, SUCCEEDED, PARTIAL_SUCCESS)
lifecycleSubstate	string	The current sub-state of the execution window. Valid states are DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS and WAITING. (DURATION_EXCEEDED, MAINTENANCE_IN_PROGRESS, WAITING)
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 execution window was created.
timeEnded	string (date-time)	The date and time that the execution window ended.
timeScheduled	string (date-time)	The scheduled start date and time of the execution window.
timeStarted	string (date-time)	The date and time that the execution window was started.
timeUpdated	string (date-time)	The last date and time that the execution window was updated.
windowDurationInMins	integer	Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes.
windowType	string	The execution window is of PLANNED or UNPLANNED type. (PLANNED, UNPLANNED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	executionWindowId, region	opc-request-id	Gets information about the specified execution window.<br />
list	select	compartmentId, region	limit, page, opc-request-id, sortBy, executionResourceId, sortOrder, lifecycleState, displayName	Lists the execution window resources in the specified compartment.<br />
create	insert	region, compartmentId, executionResourceId, timeScheduled, windowDurationInMins	opc-retry-token, opc-request-id	Creates an execution window resource.<br />
update	update	executionWindowId, region	if-match, opc-request-id	Updates the execution window resource.<br />
delete	delete	executionWindowId, region	if-match, opc-request-id	Deletes the execution window.<br />
reorder_execution_actions	exec	executionWindowId, region	if-match, opc-request-id, opc-retry-token	Reorders the execution actions under this execution window 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).
executionWindowId	string	The execution window [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)
displayName	string	A filter to return only resources that match the entire display name given. The match is not case sensitive.
executionResourceId	string	A filter to return only resources that match the given resource 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.
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 execution window.<br />

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionResourceId,
freeformTags,
isEnforcedDuration,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeEnded,
timeScheduled,
timeStarted,
timeUpdated,
windowDurationInMins,
windowType
FROM oci.database.execution_windows
WHERE executionWindowId = '{{ executionWindowId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists the execution window resources in the specified compartment.<br />

SELECT
id,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionResourceId,
freeformTags,
isEnforcedDuration,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeEnded,
timeScheduled,
timeStarted,
timeUpdated,
windowDurationInMins,
windowType
FROM oci.database.execution_windows
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 executionResourceId = '{{ executionResourceId }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND displayName = '{{ displayName }}'
;

INSERT examples

create

Creates an execution window resource.<br />

INSERT INTO oci.database.execution_windows (
compartmentId,
definedTags,
executionResourceId,
freeformTags,
isEnforcedDuration,
timeScheduled,
windowDurationInMins,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ executionResourceId }}' /* required */,
'{{ freeformTags }}',
{{ isEnforcedDuration }},
'{{ timeScheduled }}' /* required */,
{{ windowDurationInMins }} /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionResourceId,
freeformTags,
isEnforcedDuration,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeEnded,
timeScheduled,
timeStarted,
timeUpdated,
windowDurationInMins,
windowType
;

Manifest

# Description fields are for documentation purposes
- name: execution_windows
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the execution_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: executionResourceId
    value: "{{ executionResourceId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the execution resource the execution window belongs to.
  - 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: isEnforcedDuration
    value: {{ isEnforcedDuration }}
    description: |
      Indicates if duration the user plans to allocate for scheduling window is strictly enforced. The default value is `FALSE`.
    default: false
  - name: timeScheduled
    value: "{{ timeScheduled }}"
    description: |
      The scheduled start date and time of the execution window.
  - name: windowDurationInMins
    value: {{ windowDurationInMins }}
    description: |
      Duration window allows user to set a duration they plan to allocate for Scheduling window. The duration is in minutes.
  - 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 execution window resource.<br />

UPDATE oci.database.execution_windows
SET 
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
isEnforcedDuration = {{ isEnforcedDuration }},
timeScheduled = '{{ timeScheduled }}',
windowDurationInMins = {{ windowDurationInMins }}
WHERE 
executionWindowId = '{{ executionWindowId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
compartmentId,
definedTags,
description,
displayName,
estimatedTimeInMins,
executionResourceId,
freeformTags,
isEnforcedDuration,
lifecycleDetails,
lifecycleState,
lifecycleSubstate,
systemTags,
timeCreated,
timeEnded,
timeScheduled,
timeStarted,
timeUpdated,
windowDurationInMins,
windowType;

DELETE examples

delete

Deletes the execution window.<br />

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

Lifecycle Methods

reorder_execution_actions

Reorders the execution actions under this execution window resource.<br />

EXEC oci.database.execution_windows.reorder_execution_actions 
@executionWindowId='{{ executionWindowId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}', 
@opc-retry-token='{{ opc-retry-token }}' 
@@json=
'{
"definedTags": "{{ definedTags }}", 
"executionActionOrderList": "{{ executionActionOrderList }}", 
"freeformTags": "{{ freeformTags }}"
}'
;