get-application-metadata-configuration¶

Description¶

Retrieves the configuration schema and field definitions for a specific application type and version.

Synopsis¶

  get-application-metadata-configuration
--type <value>
--application-version <value>
[--size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--type (string)

CDP Application Type. AIRFLOW - Airflow CSS - Cloudera Semantic Search NOTEBOOK - Standalone Notebook Service RAY - Standalone Ray Service HTTPBIN - HTTPBin Service

Possible values:

• AIRFLOW

• CSS

--application-version (string)

The specific version of the application to retrieve configuration for.

--size (string)

The deployment size tier for the application, which affects available configuration options. Example Values: TINY,`SMALL`, LARGE, XLARGE, etc

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

title -> (string)

The display title for the configuration form or schema.

properties -> (array)

Configuration properties describing the structure and validation rules for each configurable parameter.

item -> (object)

Represents a key-value property pair.

key -> (string)

The property name/key.

value -> (object)

Structure, validation, and UI behavior for configurable application parameters.

title -> (string)

The display title of the field shown to users in forms or UI.

type -> (string)

The type of the field (string, integer, boolean, object).

description -> (string)

The description of the field.

placeholder -> (string)

The placeholder text for the field.

required -> (boolean)

Whether the field is required.

ui -> (object)

UI-specific hints for how a client should render the field.

sensitive -> (boolean)

Whether this field contains sensitive data that should be masked or hidden in UI.

isVisibleDuringInstallation -> (boolean)

Whether this field should be visible and configurable during application installation.

isEditable -> (boolean)

Whether this field can be edited after initial configuration or installation.

default -> (string)

The default value for the field.

pattern -> (string)

The regex validation pattern for the field.

enum -> (array)

The enum options for the field.

item -> (string)

minimum -> (integer)

The minimum value for the field.

maximum -> (integer)

The maximum value for the field.

properties -> (array)

The nested properties for object-type fields.

item -> (object)

Represents a key-value property pair.

key -> (string)

The property name/key.

value -> (object)

Structure, validation, and UI behavior for configurable application parameters.

title -> (string)

The display title of the field shown to users in forms or UI.

type -> (string)

The type of the field (string, integer, boolean, object).

description -> (string)

The description of the field.

placeholder -> (string)

The placeholder text for the field.

required -> (boolean)

Whether the field is required.

ui -> (object)

UI-specific hints for how a client should render the field.

sensitive -> (boolean)

Whether this field contains sensitive data that should be masked or hidden in UI.

isVisibleDuringInstallation -> (boolean)

Whether this field should be visible and configurable during application installation.

isEditable -> (boolean)

Whether this field can be edited after initial configuration or installation.

default -> (string)

The default value for the field.

pattern -> (string)

The regex validation pattern for the field.

enum -> (array)

The enum options for the field.

minimum -> (integer)

The minimum value for the field.

maximum -> (integer)

The maximum value for the field.

Form Factors¶

public