update

Description

Endpoint used to update the TaskSchedule

Usage

oci data-integration task-schedule update [OPTIONS]

Required Parameters

--application-key [text]

The application key.

--key [text]

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

--object-version [integer]

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

--task-schedule-key [text]

TaskSchedule Key

--workspace-id [text]

The workspace ID.

Optional Parameters

--auth-mode [text]

The authorization mode for the task.

Accepted values are:

OBO, RESOURCE_PRINCIPAL, USER_CERTIFICATE
--config-provider-delegate [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.

--description [text]

Detailed description for the object.

--end-time-millis [integer]

The end time in milliseconds.

--expected-duration [text]

The expected duration of the task.

--expected-duration-unit [text]

The expected duration of the task.

Accepted values are:

DAYS, HOURS, MINUTES, SECONDS
--force

Perform update without prompting for confirmation.

--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

--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.

--if-match [text]

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. When ‘if-match’ is provided and its value does not exactly match the ‘etag’ of the resource on the server, the request fails with the 412 response code.

--is-backfill-enabled [boolean]

Whether the backfill is enabled.

--is-concurrent-allowed [boolean]

Whether the same task can be executed concurrently.

--is-enabled [boolean]

enabled

--model-type [text]

The type of the object.

--model-version [text]

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

--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.

--number-of-retries [integer]

The number of retries.

--object-status [integer]

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

--parent-ref [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.

--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.

--retry-delay [text]

The retry delay, the unit for measurement is in the property retry delay unit.

--retry-delay-unit [text]

The unit for the retry delay.

Accepted values are:

DAYS, HOURS, MINUTES, SECONDS
--schedule-ref [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.

--start-time-millis [integer]

The start time in milliseconds.

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/task-schedule/update.html#cmdoption-application-key
    export key=<substitute-value-of-key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/task-schedule/update.html#cmdoption-key
    export object_version=<substitute-value-of-object_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/task-schedule/update.html#cmdoption-object-version
    export task_schedule_key=<substitute-value-of-task_schedule_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/task-schedule/update.html#cmdoption-task-schedule-key

    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 task-schedule update --application-key $application_key --key $key --object-version $object_version --task-schedule-key $task_schedule_key --workspace-id $workspace_id