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

Arguments

The asset type replace command has no arguments.

Options

Table 1: Command options
Option Description
--catalog-id Specify either a catalog ID,
 project ID, or space ID (specify one only).
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 IBM Software Hub
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Optional.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid IBM® Software Hub configuration location.
--cpd-scope The IBM Software Hub space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid IBM Software Hub 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 Provide a JMESPath query to customize the output.
Status
Optional.
Syntax
--jmes-query=<jmespath-query>
Default value
No default.
Valid values
A valid JMESPath query.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify an IBM Software Hub project instance.
Status
Optional.
Syntax
--project-id=<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 are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--space-id Specify a space identifier.
Status
Optional.
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 add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Specify the environment variables in a script file.
space_id = <Specify the deployment space identifier>
Replace asset attributes for a specific asset type. You must specify either project_id or space_id. 
cpd-cli asset type replace \
--fields= <<asset-type-fields>> \
--project-id=zen \
--space-id=${space_id} \
--type-name=<asset-type-name>