|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.cloudera.api.model.ApiConfig
public class ApiConfig
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 |
---|
public ApiConfig(String name, String value, Boolean required, String defaultValue, String displayName, String description, String relatedName, ApiConfig.ValidationState validationState, String validationMessage)
name
- The name of the parametervalue
- The value of the attributerequired
- 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.public ApiConfig(String name, String value)
public ApiConfig()
Method Detail |
---|
public String toString()
toString
in class Object
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public String getDefaultValue()
public void setDefaultValue(String defaultValue)
public String getDescription()
public void setDescription(String description)
public String getDisplayName()
public void setDisplayName(String displayName)
public String getRelatedName()
public void setRelatedName(String relatedName)
public String getName()
public void setName(String name)
public String getValue()
public void setValue(String value)
public Boolean getRequired()
public void setRequired(Boolean required)
public ApiConfig.ValidationState getValidationState()
public void setValidationState(ApiConfig.ValidationState validationState)
public String getValidationMessage()
public void setValidationMessage(String validationMessage)
public Boolean getValidationWarningsSuppressed()
public void setValidationWarningsSuppressed(Boolean validationWarningsSuppressed)
public Boolean getSensitive()
public void setSensitive(Boolean sensitive)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |