com.configcat.publicapi.java.client.model

Class PreferencesModel

java.lang.Object

com.configcat.publicapi.java.client.model.PreferencesModel

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-10T12:39:37.024419310Z[Etc/UTC]",
           comments="Generator version: 7.7.0")
public class PreferencesModel
extends java.lang.Object

PreferencesModel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PreferencesModel.CustomTypeAdapterFactory
static class	PreferencesModel.KeyGenerationModeEnum Determines the Feature Flag key generation mode.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	openapiFields
static java.util.HashSet<java.lang.String>	openapiRequiredFields
static java.lang.String	SERIALIZED_NAME_KEY_GENERATION_MODE
static java.lang.String	SERIALIZED_NAME_MANDATORY_SETTING_HINT
static java.lang.String	SERIALIZED_NAME_REASON_REQUIRED
static java.lang.String	SERIALIZED_NAME_REASON_REQUIRED_ENVIRONMENTS
static java.lang.String	SERIALIZED_NAME_SHOW_VARIATION_ID

Constructor Summary

Constructors

Constructor and Description
PreferencesModel()

Method Summary

Modifier and Type	Method and Description
PreferencesModel	addReasonRequiredEnvironmentsItem(ReasonRequiredEnvironmentModel reasonRequiredEnvironmentsItem)
boolean	equals(java.lang.Object o)
static PreferencesModel	fromJson(java.lang.String jsonString) Create an instance of PreferencesModel given an JSON string
PreferencesModel.KeyGenerationModeEnum	getKeyGenerationMode() Determines the Feature Flag key generation mode.
java.lang.Boolean	getMandatorySettingHint() Indicates whether Feature flags and Settings must have a hint.
java.lang.Boolean	getReasonRequired() Indicates that a mandatory note required for saving and publishing.
java.util.List<ReasonRequiredEnvironmentModel>	getReasonRequiredEnvironments() List of Environments where mandatory note must be set before saving and publishing.
java.lang.Boolean	getShowVariationId() Indicates whether a variation ID's must be shown on the ConfigCat Dashboard.
int	hashCode()
PreferencesModel	keyGenerationMode(PreferencesModel.KeyGenerationModeEnum keyGenerationMode)
PreferencesModel	mandatorySettingHint(java.lang.Boolean mandatorySettingHint)
PreferencesModel	reasonRequired(java.lang.Boolean reasonRequired)
PreferencesModel	reasonRequiredEnvironments(java.util.List<ReasonRequiredEnvironmentModel> reasonRequiredEnvironments)
void	setKeyGenerationMode(PreferencesModel.KeyGenerationModeEnum keyGenerationMode)
void	setMandatorySettingHint(java.lang.Boolean mandatorySettingHint)
void	setReasonRequired(java.lang.Boolean reasonRequired)
void	setReasonRequiredEnvironments(java.util.List<ReasonRequiredEnvironmentModel> reasonRequiredEnvironments)
void	setShowVariationId(java.lang.Boolean showVariationId)
PreferencesModel	showVariationId(java.lang.Boolean showVariationId)
java.lang.String	toJson() Convert an instance of PreferencesModel to an JSON string
java.lang.String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_REASON_REQUIRED

public static final java.lang.String SERIALIZED_NAME_REASON_REQUIRED

See Also:

Constant Field Values

SERIALIZED_NAME_KEY_GENERATION_MODE

public static final java.lang.String SERIALIZED_NAME_KEY_GENERATION_MODE

See Also:

Constant Field Values

SERIALIZED_NAME_SHOW_VARIATION_ID

public static final java.lang.String SERIALIZED_NAME_SHOW_VARIATION_ID

See Also:

Constant Field Values

SERIALIZED_NAME_REASON_REQUIRED_ENVIRONMENTS

public static final java.lang.String SERIALIZED_NAME_REASON_REQUIRED_ENVIRONMENTS

See Also:

Constant Field Values

SERIALIZED_NAME_MANDATORY_SETTING_HINT

public static final java.lang.String SERIALIZED_NAME_MANDATORY_SETTING_HINT

See Also:

Constant Field Values

openapiFields

public static java.util.HashSet<java.lang.String> openapiFields

openapiRequiredFields

public static java.util.HashSet<java.lang.String> openapiRequiredFields

Constructor Detail

PreferencesModel

public PreferencesModel()

Method Detail

reasonRequired

public PreferencesModel reasonRequired(java.lang.Boolean reasonRequired)

getReasonRequired

@Nullable
public java.lang.Boolean getReasonRequired()

Indicates that a mandatory note required for saving and publishing.

Returns:

reasonRequired

setReasonRequired

public void setReasonRequired(java.lang.Boolean reasonRequired)

keyGenerationMode

public PreferencesModel keyGenerationMode(PreferencesModel.KeyGenerationModeEnum keyGenerationMode)

getKeyGenerationMode

@Nullable
public PreferencesModel.KeyGenerationModeEnum getKeyGenerationMode()

Determines the Feature Flag key generation mode.

Returns:

keyGenerationMode

setKeyGenerationMode

public void setKeyGenerationMode(PreferencesModel.KeyGenerationModeEnum keyGenerationMode)

showVariationId

public PreferencesModel showVariationId(java.lang.Boolean showVariationId)

getShowVariationId

@Nullable
public java.lang.Boolean getShowVariationId()

Indicates whether a variation ID's must be shown on the ConfigCat Dashboard.

Returns:

showVariationId

setShowVariationId

public void setShowVariationId(java.lang.Boolean showVariationId)

reasonRequiredEnvironments

public PreferencesModel reasonRequiredEnvironments(java.util.List<ReasonRequiredEnvironmentModel> reasonRequiredEnvironments)

addReasonRequiredEnvironmentsItem

public PreferencesModel addReasonRequiredEnvironmentsItem(ReasonRequiredEnvironmentModel reasonRequiredEnvironmentsItem)

getReasonRequiredEnvironments

@Nullable
public java.util.List<ReasonRequiredEnvironmentModel> getReasonRequiredEnvironments()

List of Environments where mandatory note must be set before saving and publishing.

Returns:

reasonRequiredEnvironments

setReasonRequiredEnvironments

public void setReasonRequiredEnvironments(java.util.List<ReasonRequiredEnvironmentModel> reasonRequiredEnvironments)

mandatorySettingHint

public PreferencesModel mandatorySettingHint(java.lang.Boolean mandatorySettingHint)

getMandatorySettingHint

@Nullable
public java.lang.Boolean getMandatorySettingHint()

Indicates whether Feature flags and Settings must have a hint.

Returns:

mandatorySettingHint

setMandatorySettingHint

public void setMandatorySettingHint(java.lang.Boolean mandatorySettingHint)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws java.io.IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

java.io.IOException - if the JSON Element is invalid with respect to PreferencesModel

fromJson

public static PreferencesModel fromJson(java.lang.String jsonString)
                                 throws java.io.IOException

Create an instance of PreferencesModel given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of PreferencesModel

Throws:

java.io.IOException - if the JSON string is invalid with respect to PreferencesModel

toJson

public java.lang.String toJson()

Convert an instance of PreferencesModel to an JSON string

Returns:

JSON string