Package com.launchdarkly.api.model

Class Environment

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-05-16T11:29:12.794018Z[Etc/UTC]")
public class Environment
extends java.lang.Object
    Environment

    • Field Detail

      • SERIALIZED_NAME_LINKS

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

      • SERIALIZED_NAME_ID

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

      • SERIALIZED_NAME_KEY

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

      • SERIALIZED_NAME_NAME

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

      • SERIALIZED_NAME_API_KEY

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

      • SERIALIZED_NAME_MOBILE_KEY

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

      • SERIALIZED_NAME_COLOR

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

      • SERIALIZED_NAME_DEFAULT_TTL

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

      • SERIALIZED_NAME_SECURE_MODE

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

      • SERIALIZED_NAME_DEFAULT_TRACK_EVENTS

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

      • SERIALIZED_NAME_REQUIRE_COMMENTS

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

      • SERIALIZED_NAME_CONFIRM_CHANGES

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

      • SERIALIZED_NAME_TAGS

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

      • SERIALIZED_NAME_APPROVAL_SETTINGS

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

      • SERIALIZED_NAME_CRITICAL

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

      • Environment

        public Environment()

    • Method Detail

      • links

        public Environment links​(java.util.Map<java.lang.String,​Link> links)

      • putLinksItem

        public Environment putLinksItem​(java.lang.String key,
                                Link linksItem)

      • getLinks

        @Nonnull
public java.util.Map<java.lang.String,​Link> getLinks()
        The location and content type of related resources
        Returns:
        links

      • setLinks

        public void setLinks​(java.util.Map<java.lang.String,​Link> links)

      • getId

        @Nonnull
public java.lang.String getId()
        The ID for the environment. Use this as the client-side ID for authorization in some client-side SDKs, and to associate LaunchDarkly environments with CDN integrations in edge SDKs.
        Returns:
        id

      • setId

        public void setId​(java.lang.String id)

      • key

        public Environment key​(java.lang.String key)

      • getKey

        @Nonnull
public java.lang.String getKey()
        A project-unique key for the new environment
        Returns:
        key

      • setKey

        public void setKey​(java.lang.String key)

      • name

        public Environment name​(java.lang.String name)

      • getName

        @Nonnull
public java.lang.String getName()
        A human-friendly name for the new environment
        Returns:
        name

      • setName

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

      • apiKey

        public Environment apiKey​(java.lang.String apiKey)

      • getApiKey

        @Nonnull
public java.lang.String getApiKey()
        The SDK key for the environment. Use this for authorization in server-side SDKs.
        Returns:
        apiKey

      • setApiKey

        public void setApiKey​(java.lang.String apiKey)

      • mobileKey

        public Environment mobileKey​(java.lang.String mobileKey)

      • getMobileKey

        @Nonnull
public java.lang.String getMobileKey()
        The mobile key for the environment. Use this for authorization in mobile SDKs.
        Returns:
        mobileKey

      • setMobileKey

        public void setMobileKey​(java.lang.String mobileKey)

      • color

        public Environment color​(java.lang.String color)

      • getColor

        @Nonnull
public java.lang.String getColor()
        The color used to indicate this environment in the UI
        Returns:
        color

      • setColor

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

      • defaultTtl

        public Environment defaultTtl​(java.lang.Integer defaultTtl)

      • getDefaultTtl

        @Nonnull
public java.lang.Integer getDefaultTtl()
        The default time (in minutes) that the PHP SDK can cache feature flag rules locally
        Returns:
        defaultTtl

      • setDefaultTtl

        public void setDefaultTtl​(java.lang.Integer defaultTtl)

      • secureMode

        public Environment secureMode​(java.lang.Boolean secureMode)

      • getSecureMode

        @Nonnull
public java.lang.Boolean getSecureMode()
        Ensures that one end user of the client-side SDK cannot inspect the variations for another end user
        Returns:
        secureMode

      • setSecureMode

        public void setSecureMode​(java.lang.Boolean secureMode)

      • defaultTrackEvents

        public Environment defaultTrackEvents​(java.lang.Boolean defaultTrackEvents)

      • getDefaultTrackEvents

        @Nonnull
public java.lang.Boolean getDefaultTrackEvents()
        Enables tracking detailed information for new flags by default
        Returns:
        defaultTrackEvents

      • setDefaultTrackEvents

        public void setDefaultTrackEvents​(java.lang.Boolean defaultTrackEvents)

      • requireComments

        public Environment requireComments​(java.lang.Boolean requireComments)

      • getRequireComments

        @Nonnull
public java.lang.Boolean getRequireComments()
        Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment
        Returns:
        requireComments

      • setRequireComments

        public void setRequireComments​(java.lang.Boolean requireComments)

      • confirmChanges

        public Environment confirmChanges​(java.lang.Boolean confirmChanges)

      • getConfirmChanges

        @Nonnull
public java.lang.Boolean getConfirmChanges()
        Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes
        Returns:
        confirmChanges

      • setConfirmChanges

        public void setConfirmChanges​(java.lang.Boolean confirmChanges)

      • tags

        public Environment tags​(java.util.List<java.lang.String> tags)

      • addTagsItem

        public Environment addTagsItem​(java.lang.String tagsItem)

      • getTags

        @Nonnull
public java.util.List<java.lang.String> getTags()
        A list of tags for this environment
        Returns:
        tags

      • setTags

        public void setTags​(java.util.List<java.lang.String> tags)

      • getApprovalSettings

        @Nullable
public ApprovalSettings getApprovalSettings()
        Get approvalSettings
        Returns:
        approvalSettings

      • setApprovalSettings

        public void setApprovalSettings​(ApprovalSettings approvalSettings)

      • critical

        public Environment critical​(java.lang.Boolean critical)

      • getCritical

        @Nonnull
public java.lang.Boolean getCritical()
        Whether the environment is critical
        Returns:
        critical

      • setCritical

        public void setCritical​(java.lang.Boolean critical)

      • putAdditionalProperty

        public Environment 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.

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.

      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.

      • 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

      • validateJsonObject

        public static void validateJsonObject​(com.google.gson.JsonObject jsonObj)
                               throws java.io.IOException
        Validates the JSON Object and throws an exception if issues found
        Parameters:
        jsonObj - JSON Object
        Throws:
        java.io.IOException - if the JSON Object is invalid with respect to Environment

      • fromJson

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

      • toJson

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