Package com.configcat.publicapi.java.client.model

Class EnvironmentModel

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-20T16:55:24.304297906Z[Etc/UTC]",
           comments="Generator version: 7.7.0")
public class EnvironmentModel
extends java.lang.Object
    Details of the Environment.

    • Field Detail

      • SERIALIZED_NAME_PRODUCT

        public static final java.lang.String SERIALIZED_NAME_PRODUCT
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ENVIRONMENT_ID

        public static final java.lang.String SERIALIZED_NAME_ENVIRONMENT_ID
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_COLOR

        public static final java.lang.String SERIALIZED_NAME_COLOR
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_DESCRIPTION

        public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_ORDER

        public static final java.lang.String SERIALIZED_NAME_ORDER
        See Also:
        Constant Field Values

      • SERIALIZED_NAME_REASON_REQUIRED

        public static final java.lang.String SERIALIZED_NAME_REASON_REQUIRED
        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

      • EnvironmentModel

        public EnvironmentModel()

    • Method Detail

      • getProduct

        @Nullable
public ProductModel getProduct()
        Get product
        Returns:
        product

      • setProduct

        public void setProduct​(ProductModel product)

      • environmentId

        public EnvironmentModel environmentId​(java.util.UUID environmentId)

      • getEnvironmentId

        @Nullable
public java.util.UUID getEnvironmentId()
        Identifier of the Environment.
        Returns:
        environmentId

      • setEnvironmentId

        public void setEnvironmentId​(java.util.UUID environmentId)

      • getName

        @Nullable
public java.lang.String getName()
        Name of the Environment.
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)

      • getColor

        @Nullable
public java.lang.String getColor()
        The configured color of the Environment.
        Returns:
        color

      • setColor

        public void setColor​(java.lang.String color)

      • description

        public EnvironmentModel description​(java.lang.String description)

      • getDescription

        @Nullable
public java.lang.String getDescription()
        Description of the Environment.
        Returns:
        description

      • setDescription

        public void setDescription​(java.lang.String description)

      • getOrder

        @Nullable
public java.lang.Integer getOrder()
        The order of the Environment represented on the ConfigCat Dashboard.
        Returns:
        order

      • setOrder

        public void setOrder​(java.lang.Integer order)

      • reasonRequired

        public EnvironmentModel reasonRequired​(java.lang.Boolean reasonRequired)

      • getReasonRequired

        @Nullable
public java.lang.Boolean getReasonRequired()
        Determines whether a mandatory reason must be given every time when the Feature Flags or Settings in the given Environment are saved.
        Returns:
        reasonRequired

      • setReasonRequired

        public void setReasonRequired​(java.lang.Boolean reasonRequired)

      • putAdditionalProperty

        public EnvironmentModel putAdditionalProperty​(java.lang.String key,
                                              java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the EnvironmentModel instance itself

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object

      • 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 EnvironmentModel

      • fromJson

        public static EnvironmentModel fromJson​(java.lang.String jsonString)
                                 throws java.io.IOException
        Create an instance of EnvironmentModel given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of EnvironmentModel
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to EnvironmentModel

      • toJson

        public java.lang.String toJson()
        Convert an instance of EnvironmentModel to an JSON string
        Returns:
        JSON string