ScheduleClient

class oci.resource_scheduler.ScheduleClient(config, **kwargs)

Use the Resource scheduler API to manage schedules, to perform actions on a collection of resources.

Methods

__init__(config, **kwargs)	Creates a new service client
activate_schedule(schedule_id, **kwargs)	This API activates a schedule.
cancel_work_request(work_request_id, **kwargs)	This API cancels a work request.
create_schedule(create_schedule_details, …)	Creates a Schedule
deactivate_schedule(schedule_id, **kwargs)	This API deactivates a schedule.
delete_schedule(schedule_id, **kwargs)	This API deletes a schedule.
get_schedule(schedule_id, **kwargs)	This API gets information about a schedule.
get_work_request(work_request_id, **kwargs)	This API gets the details of a work request.
list_resource_types(**kwargs)	This API gets a list of schedule resource types.
list_schedules(**kwargs)	This API gets a list of schedules
list_work_request_errors(work_request_id, …)	This API lists the errors for a work request.
list_work_request_logs(work_request_id, **kwargs)	Lists the logs for a work request.
list_work_requests(**kwargs)	Lists the cloud scheduler work requests in a compartment.
update_schedule(schedule_id, …)	The API updates a schedule

__init__(config, **kwargs)

Creates a new service client

Parameters:

• config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
• service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
• timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
• signer (AbstractBaseSigner) –

  (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

  One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

• retry_strategy (obj) –

  (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

  This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

• circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
• circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
• client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
• allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

activate_schedule(schedule_id, **kwargs)

This API activates a schedule.

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• if_match (str) – (optional) This is used 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.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc_retry_token (str) – (optional) This is a token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running 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 removed from the system, then a retry of the original creation request might be rejected.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type Schedule

Return type:

Response

Example:

Click here to see an example of how to use activate_schedule API.

cancel_work_request(work_request_id, **kwargs)

This API cancels a work request.

Parameters:

• work_request_id (str) –

  (required) This is the OCID of the asynchronous work request.

• if_match (str) – (optional) This is used 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.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use cancel_work_request API.

create_schedule(create_schedule_details, **kwargs)

Creates a Schedule

Parameters:

• create_schedule_details (oci.resource_scheduler.models.CreateScheduleDetails) – (required) This API shows the details of the new schedule
• opc_retry_token (str) – (optional) This is a token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running 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 removed from the system, then a retry of the original creation request might be rejected.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type Schedule

Return type:

Response

Example:

Click here to see an example of how to use create_schedule API.

deactivate_schedule(schedule_id, **kwargs)

This API deactivates a schedule.

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• if_match (str) – (optional) This is used 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.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• opc_retry_token (str) – (optional) This is a token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running 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 removed from the system, then a retry of the original creation request might be rejected.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type Schedule

Return type:

Response

Example:

Click here to see an example of how to use deactivate_schedule API.

delete_schedule(schedule_id, **kwargs)

This API deletes a schedule.

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• if_match (str) – (optional) This is used 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.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_schedule API.

get_schedule(schedule_id, **kwargs)

This API gets information about a schedule.

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type Schedule

Return type:

Response

Example:

Click here to see an example of how to use get_schedule API.

get_work_request(work_request_id, **kwargs)

This API gets the details of a work request.

Parameters:

• work_request_id (str) –

  (required) This is the OCID of the asynchronous work request.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequest

Return type:

Response

Example:

Click here to see an example of how to use get_work_request API.

list_resource_types(**kwargs)

This API gets a list of schedule resource types.

Parameters:

• compartment_id (str) –

  (optional) This is the OCID of the compartment in which to list resources.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• page (str) –

  (optional) This used for list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ResourceTypeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_resource_types API.

list_schedules(**kwargs)

This API gets a list of schedules

Parameters:

• compartment_id (str) –

  (optional) This is the OCID of the compartment in which to list resources.

• lifecycle_state (str) –

  (optional) This is a filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  Allowed values are: “ACTIVE”, “INACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”

• display_name (str) – (optional) This is a filter to return only resources that match the given display name exactly.
• schedule_id (str) –

  (optional) This is the OCID of the schedule.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• page (str) –

  (optional) This used for list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• sort_by (str) –

  (optional) This is the field to sort by. You can provide only one sort order. The default order for timeCreated is descending. The default order for displayName is ascending.

  Allowed values are: “timeCreated”, “displayName”, “lifecycleState”, “state”

• sort_order (str) –

  (optional) This is the sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type ScheduleCollection

Return type:

Response

Example:

Click here to see an example of how to use list_schedules API.

list_work_request_errors(work_request_id, **kwargs)

This API lists the errors for a work request.

Parameters:

• work_request_id (str) –

  (required) This is the OCID of the asynchronous work request.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• page (str) –

  (optional) This used for list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• sort_by (str) –

  (optional) This is the field to sort by. Only one sort order may be provided. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) This is the sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestErrorCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_errors API.

list_work_request_logs(work_request_id, **kwargs)

Lists the logs for a work request.

Parameters:

• work_request_id (str) –

  (required) This is the OCID of the asynchronous work request.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• page (str) –

  (optional) This used for list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• sort_by (str) –

  (optional) This is the field to sort by. Only one sort order may be provided. Default order for timestamp is descending.

  Allowed values are: “timestamp”

• sort_order (str) –

  (optional) This is the sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestLogEntryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_request_logs API.

list_work_requests(**kwargs)

Lists the cloud scheduler work requests in a compartment.

Parameters:

• compartment_id (str) –

  (optional) This is the OCID of the compartment in which to list resources.

• work_request_id (str) –

  (optional) This is the OCID of the asynchronous work request.

• status (str) –

  (optional) This is a filter to return only the resources that match the given lifecycle state.

  Allowed values are: “ACCEPTED”, “IN_PROGRESS”, “WAITING”, “NEEDS_ATTENTION”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”

• resource_id (str) –

  (optional) This is the OCID of the resource affected by the work request.

• page (str) –

  (optional) This used for list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

• limit (int) –

  (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

• sort_order (str) –

  (optional) This is the sort order to use, either ascending (ASC) or descending (DESC).

  Allowed values are: “ASC”, “DESC”

• sort_by (str) –

  (optional) This is the field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.

  Allowed values are: “timeAccepted”

• schedule_id (str) –

  (optional) This is the OCID of the schedule.

• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type WorkRequestSummaryCollection

Return type:

Response

Example:

Click here to see an example of how to use list_work_requests API.

update_schedule(schedule_id, update_schedule_details, **kwargs)

The API updates a schedule

Parameters:

• schedule_id (str) –

  (required) This is the OCID of the schedule.

• update_schedule_details (oci.resource_scheduler.models.UpdateScheduleDetails) – (required) The information about a schedule that will be updated.
• if_match (str) – (optional) This is used 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.
• opc_request_id (str) – (optional) This is a unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• retry_strategy (obj) –

  (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

  This should be one of the strategies available in the retry module. This operation uses DEFAULT_RETRY_STRATEGY as default if no retry strategy is provided. The specifics of the default retry strategy are described here.

  To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

• allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use update_schedule API.