create-monthly-rule-frequency

Description

Endpoint to create a new schedule

Usage

oci data-integration schedule create-monthly-rule-frequency [OPTIONS]

Required Parameters

--application-key [text]

The application key.

--identifier [text]

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

--name [text]

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

--workspace-id [text]

The workspace ID.

Optional Parameters

--day-of-week [text]

This holds the day of the week on which the schedule should be triggered.

Accepted values are:

FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY
--description [text]

Detailed description for the object.

--frequency [text]

the frequency of the schedule.

Accepted values are:

CUSTOM, DAILY, HOURLY, MONTHLY, WEEKLY
--frequency-details-time [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--interval [integer]

This hold the repeatability aspect of a schedule. i.e. in a monhtly frequency, a task can be scheduled for every month, once in two months, once in tree months etc.

--is-daylight-adj-enabled [boolean]

A flag to indicate whether daylight adjustment should be considered or not.

--key [text]

Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create.

--model-version [text]

This is a version number that is used by the service to upgrade objects if needed through releases of the service.

--object-status [integer]

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

--object-version [integer]

This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

--registry-metadata [complex type]

This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--timezone [text]

The timezone for the schedule.

--week-of-month [text]

This holds the week of the month in which the schedule should be triggered.

Accepted values are:

FIFTH, FIRST, FOURTH, LAST, SECOND, THIRD

Example using required parameter

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/workspace/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/workspace/create.html#cmdoption-display-name
    export is_private_network=<substitute-value-of-is_private_network> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/workspace/create.html#cmdoption-is-private-network
    export application_key=<substitute-value-of-application_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/schedule/create-monthly-rule-frequency.html#cmdoption-application-key
    export identifier=<substitute-value-of-identifier> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/schedule/create-monthly-rule-frequency.html#cmdoption-identifier

    workspace_id=$(oci data-integration workspace create --compartment-id $compartment_id --display-name $display_name --is-private-network $is_private_network --query data.id --raw-output)

    oci data-integration schedule create-monthly-rule-frequency --application-key $application_key --identifier $identifier --name $name --workspace-id $workspace_id