"update"
********


Description
===========

Updates a specific data entity.


Usage
=====

   oci data-catalog entity update [OPTIONS]


Required Parameters
===================

--catalog-id [text]

Unique catalog identifier.

--data-asset-key [text]

Unique data asset key.

--entity-key [text]

Unique entity key.


Optional Parameters
===================

--description [text]

Detailed description of a data entity.

--display-name [text]

A user-friendly display name. Does not have to be unique, and it's
changeable. Avoid entering confidential information.

--folder-key [text]

Key of the associated folder.

--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--harvest-status [text]

Status of the object as updated by the harvest process. When an entity
object is created, it's harvest status will indicate if the entity's
metadata has been fully harvested or not. The harvest process can
perform shallow harvesting to allow users to browse the metadata and
can on-demand deep harvest on any object This requires a harvest
status indicator for catalog objects.

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

--is-logical [boolean]

Property to indicate if the object is a physical materialized object
or virtual. For example, View.

--is-partition [boolean]

Property to indicate if the object is a sub object of a parent
physical object.

--last-job-key [text]

Key of the last harvest process to update this object.

--properties [complex type]

A map of maps that contains the properties which are specific to the
entity type. Each entity type definition defines it's set of required
and optional properties. The map keys are category names and the
values are maps of property name to property value. Every property is
contained inside of a category. Most entities have required properties
within the "default" category. To determine the set of required and
optional properties for an entity type, a query can be done on
'/types?type=dataEntity' that returns a collection of all entity
types. The appropriate entity type, which includes definitions of all
of it's properties, can be identified from this collection. Example:
*{"properties": { "default": { "key1": "value1"}}}* 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.

--time-external [datetime]

Last modified timestamp of the object in the external system.

The following datetime formats are supported:


UTC with milliseconds
---------------------

   Format: YYYY-MM-DDTHH:mm:ss.sssTZD
   Example: 2017-09-15T20:30:00.123Z


UTC without milliseconds
------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T20:30:00Z


UTC with minute precision
-------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T20:30Z


Timezone with milliseconds
--------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800


Timezone without milliseconds
-----------------------------

   Format: YYYY-MM-DDTHH:mm:ssTZD
   Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800


Timezone with minute precision
------------------------------

   Format: YYYY-MM-DDTHH:mmTZD
   Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800


Short date and time
-------------------

The timezone for this date and time will be taken as UTC (Needs to be
surrounded by single or double quotes)

   Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
   Example: '2017-09-15 17:25'


Date Only
---------

This date will be taken as midnight UTC of that day

   Format: YYYY-MM-DD
   Example: 2017-09-15


Epoch seconds
-------------

   Example: 1412195400


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth", "--cert-bundle", "--cli-rc-file", "--config-file", "--
debug", "--defaults-file", "--endpoint", "--generate-full-command-
json-input", "--generate-param-json-input", "--help", "--no-retry", "
--opc-client-request-id", "--opc-request-id", "--output", "--profile",
"--query", "--raw-output", "--region", "--request-id", "--version",
"-?", "-d", "-h", "-v"
