oci-service-operator

resourcescheduler.oracle.com/v1beta1

Back to API Reference

APIVersion: resourcescheduler.oracle.com/v1beta1

This content is generated from the checked-in CRD schemas in config/crd/bases/. If a description is missing or incorrect, fix the source comments or generator inputs and rerun make generate manifests; do not hand-edit config/crd/bases/*.yaml.

Packages

No customer-visible package currently exposes resourcescheduler.oracle.com/v1beta1.

Resources

Kind Scope Sample Packages
Schedule Namespaced Sample -

Schedule

Schedule is the Schema for the schedules API.

Spec

ScheduleSpec defines the desired state of Schedule.

Field Description Type Required Default Enum
action This is the action that will be executed by the schedule. string Yes - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the schedule is created string Yes - -
definedTags These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description This is the description of the schedule. string No - -
displayName This is a user-friendly name for the schedule. It does not have to be unique, and it’s changeable. string No - -
freeformTags These are 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
recurrenceDetails This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. string Yes - -
recurrenceType Type of recurrence of a schedule string Yes - -
resourceFilters This is a list of resources filters. The schedule will be applied to resources matching all of them. list[object] No - -
resources This is the list of resources to which the scheduled operation is applied. list[object] No - -
timeEnds This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z string No - -
timeStarts This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z string No - -

Spec.resourceFilters[]

Back to Schedule spec

ScheduleResourceFilter defines nested fields for Schedule.ResourceFilter.

Field Description Type Required Default Enum
attribute - string No - -
condition This is the condition for the filter in comparison to its creation time. string No - -
jsonData - string No - -
shouldIncludeChildCompartments This sets whether to include child compartments. boolean No - -
value This is the date and time as the value of the filter. string No - -

Spec.resources[]

Back to Schedule spec

ScheduleResource defines nested fields for Schedule.Resource.

Field Description Type Required Default Enum
id This is the resource OCID. string Yes - -
metadata This is additional information that helps to identity the resource for the schedule. { “id”: “" "metadata": { "namespaceName": "sampleNamespace", "bucketName": "sampleBucket" } } map[string, string] No - -
parameters This is the user input parameters to use when acting on the resource. { “parameters”: [ { “parameterType”: “BODY”, “value”: { “ip”: “192.168.44.44”, “memory”: “1024”, “synced_folders”: [ { “host_path”: “data/”, “guest_path”: “/var/www”, “type”: “default” } ], “forwarded_ports”: [] } }, { “parameterType”: “PATH”, “value”: { “compartmentId”: “ocid1.compartment.oc1..xxxxx”, “instanceId”: “ocid1.vcn.oc1..yyyy” } }, { “parameterType”: “QUERY”, “value”: { “limit”: “10”, “tenantId”: “ocid1.tenant.oc1..zzzz” } }, { “parameterType”: “HEADER”, “value”: { “token”: “xxxx” } } ] } list[object] No - -

Spec.resources[].parameters[]

Back to Schedule spec

ScheduleResourceParameter defines nested fields for Schedule.Resource.Parameter.

Field Description Type Required Default Enum
jsonData - string No - -
parameterType - string No - -
value This is the query parameter value. map[string, string] No - -

Status

ScheduleStatus defines the observed state of Schedule.

Field Description Type Required Default Enum
action This is the action that will be executed by the schedule. string No - -
compartmentId The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the schedule is created string No - -
definedTags These are defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Operations": {"CostCenter": "42"}} map[string, map[string, string]] No - -
description This is the description of the schedule. string No - -
displayName This is a user-friendly name for the schedule. It does not have to be unique, and it’s changeable. string No - -
freeformTags These are 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 (https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"} map[string, string] No - -
id The OCID (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the schedule string No - -
lastRunStatus This is the status of the last work request. string No - -
lifecycleState This is the current state of a schedule. string No - -
recurrenceDetails This is the frequency of recurrence of a schedule. The frequency field can either conform to RFC-5545 formatting or UNIX cron formatting for recurrences, based on the value specified by the recurrenceType field. string No - -
recurrenceType Type of recurrence of a schedule string No - -
resourceFilters This is a list of resources filters. The schedule will be applied to resources matching all of them. list[object] No - -
resources This is the list of resources to which the scheduled operation is applied. list[object] No - -
status - object Yes - -
systemTags These are system tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud": {"free-tier-retained": "true"}} map[string, map[string, string]] No - -
timeCreated This is the date and time the schedule was created, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeEnds This is the date and time the schedule ends, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z string No - -
timeLastRun This is the date and time the schedule runs last time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeNextRun This is the date and time the schedule run the next time, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -
timeStarts This is the date and time the schedule starts, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339) Example: 2016-08-25T21:10:29.600Z string No - -
timeUpdated This is the date and time the schedule was updated, in the format defined by RFC 3339 (https://tools.ietf.org/html/rfc3339). Example: 2016-08-25T21:10:29.600Z string No - -

Status.resourceFilters[]

Back to Schedule status

ScheduleResourceFilter defines nested fields for Schedule.ResourceFilter.

Field Description Type Required Default Enum
attribute - string No - -
condition This is the condition for the filter in comparison to its creation time. string No - -
jsonData - string No - -
shouldIncludeChildCompartments This sets whether to include child compartments. boolean No - -
value This is the date and time as the value of the filter. string No - -

Status.resources[]

Back to Schedule status

ScheduleResource defines nested fields for Schedule.Resource.

Field Description Type Required Default Enum
id This is the resource OCID. string Yes - -
metadata This is additional information that helps to identity the resource for the schedule. { “id”: “" "metadata": { "namespaceName": "sampleNamespace", "bucketName": "sampleBucket" } } map[string, string] No - -
parameters This is the user input parameters to use when acting on the resource. { “parameters”: [ { “parameterType”: “BODY”, “value”: { “ip”: “192.168.44.44”, “memory”: “1024”, “synced_folders”: [ { “host_path”: “data/”, “guest_path”: “/var/www”, “type”: “default” } ], “forwarded_ports”: [] } }, { “parameterType”: “PATH”, “value”: { “compartmentId”: “ocid1.compartment.oc1..xxxxx”, “instanceId”: “ocid1.vcn.oc1..yyyy” } }, { “parameterType”: “QUERY”, “value”: { “limit”: “10”, “tenantId”: “ocid1.tenant.oc1..zzzz” } }, { “parameterType”: “HEADER”, “value”: { “token”: “xxxx” } } ] } list[object] No - -

Status.resources[].parameters[]

Back to Schedule status

ScheduleResourceParameter defines nested fields for Schedule.Resource.Parameter.

Field Description Type Required Default Enum
jsonData - string No - -
parameterType - string No - -
value This is the query parameter value. map[string, string] No - -

Status.status

Back to Schedule status

Field Description Type Required Default Enum
async Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first. object No - -
conditions - list[object] No - -
createdAt - string (date-time) No - -
deletedAt - string (date-time) No - -
message - string No - -
ocid - string No - -
opcRequestId OpcRequestID is the latest non-empty OCI request ID from a mutating OCI response or surfaced OCI service error that materially contributed to the current shared status projection. Headerless follow-up observations keep the last non-empty value intact. string No - -
reason - string No - -
requestedAt - string (date-time) No - -
updatedAt - string (date-time) No - -

Status.status.async

Back to Schedule status

Async is the canonical controller-owned async contract. Resource-local legacy work-request fields may remain as compatibility mirrors while follow-on migrations land, but new async state should project here first.

Field Description Type Required Default Enum
current - object No - -

Status.status.async.current

Back to Schedule status

Field Description Type Required Default Enum
message - string No - -
normalizedClass - string Yes - attention, canceled, failed, pending, succeeded, unknown
percentComplete - number No - -
phase - string Yes - create, delete, update
rawOperationType - string No - -
rawStatus - string No - -
source - string Yes - lifecycle, none, workrequest
updatedAt - string (date-time) Yes - -
workRequestId - string No - -

Status.status.conditions[]

Back to Schedule status

Field Description Type Required Default Enum
lastTransitionTime - string (date-time) No - -
message - string No - -
reason - string No - -
status - string Yes - -
type - string Yes - -
This site is open source. Improve this page.