list
¶
Description¶
Returns a list of custom properties within a data catalog.
Required Parameters¶
-
--catalog-id
[text]
¶
Unique catalog identifier.
-
--namespace-id
[text]
¶
Unique namespace identifier.
Optional Parameters¶
-
--all
¶
Fetches all pages of results. If you provide this option, then you cannot provide the --limit
option.
-
--created-by-id
[text]
¶
OCID of the user who created the resource.
-
--data-types
[text]
¶
Return the custom properties which has specified data types
Accepted values are:
BOOLEAN, DATE, NUMBER, RICH_TEXT, TEXT
-
--display-name
[text]
¶
A filter to return only resources that match the entire display name given. The match is not case sensitive.
-
--display-name-contains
[text]
¶
A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu".
-
--fields
[text]
¶
Specifies the fields to return in a custom property summary response.
Accepted values are:
dataType, description, displayName, key, lifecycleState, namespaceName, timeCreated
-
--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
-
--lifecycle-state
[text]
¶
A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
Accepted values are:
ACTIVE, CREATING, DELETED, DELETING, FAILED, INACTIVE, MOVING, UPDATING
-
--limit
[integer]
¶
The maximum number of items to return.
-
--page
[text]
¶
The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
-
--page-size
[integer]
¶
When fetching results, the number of results to fetch per call. Only valid when used with --all
or --limit
, and ignored otherwise.
-
--sort-by
[text]
¶
The field to sort by. Only one sort order may be provided. Default order for USAGECOUNT and DISPLAYNAME is Ascending
Accepted values are:
DISPLAYNAME, USAGECOUNT
-
--sort-order
[text]
¶
The sort order to use, either 'asc' or 'desc'.
Accepted values are:
ASC, DESC
-
--time-created
[datetime]
¶
Time that the resource was created. An RFC3339 formatted datetime string.
The following datetime formats are supported:
Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00ZFormat: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800The 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'This date will be taken as midnight UTC of that day
Format: YYYY-MM-DD Example: 2017-09-15Example: 1412195400
-
--time-updated
[datetime]
¶
Time that the resource was updated. An RFC3339 formatted datetime string.
The following datetime formats are supported:
Format: YYYY-MM-DDTHH:mm:ss.sssTZD Example: 2017-09-15T20:30:00.123ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T20:30:00ZFormat: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T20:30ZFormat: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800Format: YYYY-MM-DDTHH:mm:ssTZD Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800Format: YYYY-MM-DDTHH:mmTZD Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800The 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'This date will be taken as midnight UTC of that day
Format: YYYY-MM-DD Example: 2017-09-15Example: 1412195400
-
--type-name
[text]
¶
A filter to return only resources that match the entire type name given. The match is not case sensitive
Accepted values are:
ATTRIBUTE, AUTONOMOUS_DATA_WAREHOUSE, AUTONOMOUS_TRANSACTION_PROCESSING, BUCKET, CATEGORY, CONNECTION, DATA_ASSET, DATA_ENTITY, FILE, FOLDER, GLOSSARY, HIVE, IBM_DB2, KAFKA, LOGICAL_ENTITY, MESSAGE, MICROSOFT_AZURE_SQL_DATABASE, MICROSOFT_SQL_SERVER, MYSQL, ORACLE, ORACLE_OBJECT_STORAGE, POSTGRESQL, TABLE, TERM, UNRECOGNIZED_FILE, VIEW
-
--updated-by-id
[text]
¶
OCID of the user who updated the resource.
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-rc-file
, --config-file
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --query
, --raw-output
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -v