ApiConfig

Properties

Name Type Description Notes
name str Readonly. The canonical name that identifies this configuration parameter. [optional]
value str The user-defined value. When absent, the default value (if any) will be used. Can also be absent, when enumerating allowed configs. [optional]
required bool Readonly. Requires "full" view. Whether this configuration is required for the object. If any required configuration is not set, operations on the object may not work. [optional]
default str Readonly. Requires "full" view. The default value. [optional]
display_name str Readonly. Requires "full" view. A user-friendly name of the parameters, as would have been shown in the web UI. [optional]
description str Readonly. Requires "full" view. A textual description of the parameter. [optional]
related_name str Readonly. Requires "full" view. If applicable, contains the related configuration variable used by the source project. [optional]
sensitive bool Readonly. Whether this configuration is sensitive, i.e. contains information such as passwords, which might affect how the value of this configuration might be shared by the caller. Available since v14. [optional]
validation_state ValidationState Readonly. Requires "full" view. State of the configuration parameter after validation. [optional]
validation_message str Readonly. Requires "full" view. A message explaining the parameter's validation state. [optional]
validation_warnings_suppressed bool Readonly. Requires "full" view. Whether validation warnings associated with this parameter are suppressed. In general, suppressed validation warnings are hidden in the Cloudera Manager UI. Configurations that do not produce warnings will not contain this field. [optional]

[Back to Model list] [Back to API list] [Back to README]