``update`` ========== .. contents:: :local: :depth: 1 Description ------------ Updates a specific data asset with default connection. Usage ----- .. code-block:: none oci data-integration data-asset update [OPTIONS] Required Parameters -------------------- .. option:: --data-asset-key [text] The data asset key. .. option:: --key [text] Generated key that can be used in API calls to identify data asset. .. option:: --model-type [text] The type of the data asset. Accepted values are: .. code-block:: py AMAZON_S3_DATA_ASSET, FUSION_APP_DATA_ASSET, GENERIC_JDBC_DATA_ASSET, HDFS_DATA_ASSET, LAKE_DATA_ASSET, MYSQL_DATA_ASSET, MYSQL_HEATWAVE_DATA_ASSET, ORACLE_ADWC_DATA_ASSET, ORACLE_ATP_DATA_ASSET, ORACLE_DATA_ASSET, ORACLE_EBS_DATA_ASSET, ORACLE_OBJECT_STORAGE_DATA_ASSET, ORACLE_PEOPLESOFT_DATA_ASSET, ORACLE_SIEBEL_DATA_ASSET, REST_DATA_ASSET .. option:: --object-version [integer] The version of the object that is used to track changes in the object instance. .. option:: --workspace-id [text] The workspace ID. Optional Parameters -------------------- .. option:: --asset-properties [complex type] Additional properties for the data asset. 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 :option:`--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. .. option:: --credential-file-content [text] The credential file content from a Autonomous Data Warehouse wallet. .. option:: --data-asset-type [text] The data asset type for the generic JDBC data asset. .. option:: --default-connection [text] 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 :option:`--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. .. option:: --description [text] The user-defined description of the data asset. .. option:: --driver-class [text] The Autonomous Data Warehouse driver class. .. option:: --external-key [text] The external key for the object. .. option:: --force Perform update without prompting for confirmation. .. option:: --from-json [text] Provide input to this command as a JSON document from a file using the file://path-to/file syntax. The :option:`--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 .. option:: --host [text] The Oracle Database hostname. .. option:: --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. .. option:: --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. .. option:: --model-version [text] The model version of an object. .. option:: --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. .. option:: --namespace [text] The namespace for the specified Oracle Object storage resource. You can find the namespace under Object Storage Settings in the Console. .. option:: --object-status [integer] The status of an object that can be set to value 1 for shallow references across objects, other values reserved. .. option:: --port [text] The Oracle Database port. .. option:: --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 :option:`--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. .. option:: --service-name [text] The Autonomous Data Warehouse instance service name. .. option:: --sid [text] The Oracle Database SID. .. option:: --tenancy-id [text] The OCI tenancy OCID. .. option:: --url [text] The Oracle Object storage URL. Global Parameters ------------------ Use ``oci --help`` for help on global parameters. :option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v` 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. .. code-block:: none :class: copy-code-block export 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= # 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= # 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 data_asset_key= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/data-asset/update.html#cmdoption-data-asset-key export key= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/data-asset/update.html#cmdoption-key export model_type= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/data-asset/update.html#cmdoption-model-type export object_version= # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-integration/data-asset/update.html#cmdoption-object-version 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 data-asset update --data-asset-key $data_asset_key --key $key --model-type $model_type --object-version $object_version --workspace-id $workspace_id