com.cloudera.api.model
Class ApiConfig

java.lang.Object
  com.cloudera.api.model.ApiConfig

public class ApiConfig
extends Object

Model for a configuration parameter. When an entry's value property is not available, it means the entry is not configured. This means that the default value for the entry, if any, will be used. Setting a value to null also can be used to unset any previously set value for the parameter, reverting to the default value (if any).

Nested Class Summary

static class

ApiConfig.ValidationState

Constructor Summary

ApiConfig()

ApiConfig(String name, String value)

ApiConfig(String name, String value, Boolean required, String defaultValue, String displayName, String description, String relatedName, ApiConfig.ValidationState validationState, String validationMessage)

Method Summary

boolean	equals(Object o)
String	getDefaultValue() Readonly.
String	getDescription() Readonly.
String	getDisplayName() Readonly.
String	getName() Readonly.
String	getRelatedName() Readonly.
Boolean	getRequired() Readonly.
Boolean	getSensitive() Readonly.
String	getValidationMessage() Readonly.
ApiConfig.ValidationState	getValidationState() Readonly.
Boolean	getValidationWarningsSuppressed() Readonly.
String	getValue() The user-defined value.
int	hashCode()
void	setDefaultValue(String defaultValue)
void	setDescription(String description)
void	setDisplayName(String displayName)
void	setName(String name)
void	setRelatedName(String relatedName)
void	setRequired(Boolean required)
void	setSensitive(Boolean sensitive)
void	setValidationMessage(String validationMessage)
void	setValidationState(ApiConfig.ValidationState validationState)
void	setValidationWarningsSuppressed(Boolean validationWarningsSuppressed)
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ApiConfig

public ApiConfig(String name,
                 String value,
                 Boolean required,
                 String defaultValue,
                 String displayName,
                 String description,
                 String relatedName,
                 ApiConfig.ValidationState validationState,
                 String validationMessage)

Parameters:

name - The name of the parameter

value - The value of the attribute

required - Whether the configuration value is required.

defaultValue - The default value, if any.

displayName - Name of the attribute as displayed in the UI.

description - Description of the configuration.

relatedName - Related config Alternative information about the parameter.

validationState - State of the parameter's validation.

validationMessage - Message describing any validation issues.

ApiConfig

public ApiConfig(String name,
                 String value)

ApiConfig

public ApiConfig()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getDefaultValue

public String getDefaultValue()

Readonly. Requires "full" view. The default value.

setDefaultValue

public void setDefaultValue(String defaultValue)

getDescription

public String getDescription()

Readonly. Requires "full" view. A textual description of the parameter.

setDescription

public void setDescription(String description)

getDisplayName

public String getDisplayName()

Readonly. Requires "full" view. A user-friendly name of the parameters, as would have been shown in the web UI.

setDisplayName

public void setDisplayName(String displayName)

getRelatedName

public String getRelatedName()

Readonly. Requires "full" view. If applicable, contains the related configuration variable used by the source project.

setRelatedName

public void setRelatedName(String relatedName)

getName

public String getName()

Readonly. The canonical name that identifies this configuration parameter.

setName

public void setName(String name)

getValue

public String getValue()

The user-defined value. When absent, the default value (if any) will be used. Can also be absent, when enumerating allowed configs.

setValue

public void setValue(String value)

getRequired

public Boolean getRequired()

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.

setRequired

public void setRequired(Boolean required)

getValidationState

public ApiConfig.ValidationState getValidationState()

Readonly. Requires "full" view. State of the configuration parameter after validation.

setValidationState

public void setValidationState(ApiConfig.ValidationState validationState)

getValidationMessage

public String getValidationMessage()

Readonly. Requires "full" view. A message explaining the parameter's validation state.

setValidationMessage

public void setValidationMessage(String validationMessage)

getValidationWarningsSuppressed

public Boolean getValidationWarningsSuppressed()

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.

setValidationWarningsSuppressed

public void setValidationWarningsSuppressed(Boolean validationWarningsSuppressed)

getSensitive

public Boolean getSensitive()

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.

setSensitive

public void setSensitive(Boolean sensitive)