asset type replace

Replace asset attributes for the specified asset type or create an asset type when the specified asset type does not exist.

Syntax

cpd-cli asset type replace \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--description=<description>] \
[--external-asset-preview=<asset-url-model>] \
--fields=<asset-type-fields> \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-project-id>] \
[--properties=<asset-type-properties>] \
[--quiet] \
[--raw-output=true|false] \
[--relationships=<relationship-definition>] \
[--space-id=<space-identifier>] \
--type-name=<asset-type-name> \
[--verbose] \
[--x-open-id-connect-id-token=<x-open-id-connect-id-token>]

Arguments

The asset type replace command has no arguments.

Options

Option Description
--catalog-id Specify either a catalog ID,
project ID, or space ID (specify only one).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project or space ID.
--context Specify the configuration context 
name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
configuration location (for example, $HOME/.cpd-cli/config).
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope (for example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135).
Status
Optional.
Syntax
--cpd-scope=<cpd-config-location>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--description Specify a data asset
 description.
Status
Optional.
Syntax
--description=<description>
Default value
No default.
Valid values
A valid data asset description.
--external-asset-preview Specify the asset type URL model.
Status
Optional.
Syntax
--external-asset-preview=<asset-url-model>
Default value
No default.
Valid values
A valid asset type URL model.
--fields Specify the asset type fields (AssetTypeField object) to index.
Status
Required.
Syntax
--fields=<asset-type-fields>
Default value
No default.
Valid values
A valid AssetTypeField object.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid lucene query.
--output Specify an output format. Valid formats include json, yaml, or text (the default format).
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
json|yaml|text
--output-file Specify a file path where all output is redirected.
Status
Required.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The profile-name from the Cloud Pak for Data configuration.
Status
Required.
Syntax
--profile=<cpd-configuration-profile-name>
Default value
default
Valid values
Any valid profile name from the Cloud Pak for Data configuration.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
A valid project identifier.
--properties Specify descriptions for expected
asset type properties. Each property can be described by its name and an 'AssetTypeProperty'
object.
Status
Optional.
Syntax
--properties=<asset-type-properties>
Default value
No default.
Valid values
A valid JSON AssetTypeProperty object.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values in
 JSON output mode are not surrounded by quotes.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotes.
true
Single values in JSON output mode are not surrounded by quotes.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--type-name The asset type name (for example,
'data_asset').
Status
Required.
Syntax
--type-name=<asset-type-name>
Default value
No default.
Valid values
A valid asset type name.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.
--x-open-id-connect-id-token Specify the X-OpenID-Connect-ID-Token.
Status
Optional.
Syntax
--x-open-id-connect-id-token=<x-open-id-connect-id-token>
Default value
No default.
Valid values
A valid X-OpenID-Connect-ID-Token.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can optionally add the listed environment variables to the install variables script. For more information, see Best practice: Setting up install variables.
Specify the environment variables in a script file.
project_id = <The Cloud Pak for Data project instance>
space_id = <Specify the deployment space identifier>
Replace asset attributes for a specific asset type.
cpd-cli asset type replace \
--fields= <Specify the asset type fields (AssetTypeField object) to index.> \
--project-id=${PROJECT_CPD_INSTANCE} \
--space-id=${space_id} \
--type-name=<asset-type-name>