Class FeatureFlag


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-03-05T10:45:26.516033Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class FeatureFlag
    extends java.lang.Object
    FeatureFlag
    • Field Detail

      • SERIALIZED_NAME_NAME

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

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

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

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

        public static final java.lang.String SERIALIZED_NAME_VERSION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CREATION_DATE

        public static final java.lang.String SERIALIZED_NAME_CREATION_DATE
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_INCLUDE_IN_SNIPPET

        public static final java.lang.String SERIALIZED_NAME_INCLUDE_IN_SNIPPET
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CLIENT_SIDE_AVAILABILITY

        public static final java.lang.String SERIALIZED_NAME_CLIENT_SIDE_AVAILABILITY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VARIATIONS

        public static final java.lang.String SERIALIZED_NAME_VARIATIONS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_TEMPORARY

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

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

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

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_MAINTAINER

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_MAINTAINER_TEAM_KEY

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER_TEAM_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_MAINTAINER_TEAM

        public static final java.lang.String SERIALIZED_NAME_MAINTAINER_TEAM
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_GOAL_IDS

        public static final java.lang.String SERIALIZED_NAME_GOAL_IDS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_EXPERIMENTS

        public static final java.lang.String SERIALIZED_NAME_EXPERIMENTS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CUSTOM_PROPERTIES

        public static final java.lang.String SERIALIZED_NAME_CUSTOM_PROPERTIES
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ARCHIVED

        public static final java.lang.String SERIALIZED_NAME_ARCHIVED
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ARCHIVED_DATE

        public static final java.lang.String SERIALIZED_NAME_ARCHIVED_DATE
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DEPRECATED

        public static final java.lang.String SERIALIZED_NAME_DEPRECATED
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DEPRECATED_DATE

        public static final java.lang.String SERIALIZED_NAME_DEPRECATED_DATE
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DEFAULTS

        public static final java.lang.String SERIALIZED_NAME_DEFAULTS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_PURPOSE

        public static final java.lang.String SERIALIZED_NAME_PURPOSE
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_MIGRATION_SETTINGS

        public static final java.lang.String SERIALIZED_NAME_MIGRATION_SETTINGS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_ENVIRONMENTS

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

      • FeatureFlag

        public FeatureFlag()
    • Method Detail

      • name

        public FeatureFlag name​(@Nonnull
                                java.lang.String name)
      • getName

        @Nonnull
        public java.lang.String getName()
        A human-friendly name for the feature flag
        Returns:
        name
      • setName

        public void setName​(@Nonnull
                            java.lang.String name)
      • description

        public FeatureFlag description​(@Nullable
                                       java.lang.String description)
      • getDescription

        @Nullable
        public java.lang.String getDescription()
        Description of the feature flag
        Returns:
        description
      • setDescription

        public void setDescription​(@Nullable
                                   java.lang.String description)
      • key

        public FeatureFlag key​(@Nonnull
                               java.lang.String key)
      • getKey

        @Nonnull
        public java.lang.String getKey()
        A unique key used to reference the flag in your code
        Returns:
        key
      • setKey

        public void setKey​(@Nonnull
                           java.lang.String key)
      • version

        public FeatureFlag version​(@Nonnull
                                   java.lang.Integer version)
      • getVersion

        @Nonnull
        public java.lang.Integer getVersion()
        Version of the feature flag
        Returns:
        version
      • setVersion

        public void setVersion​(@Nonnull
                               java.lang.Integer version)
      • creationDate

        public FeatureFlag creationDate​(@Nonnull
                                        java.lang.Long creationDate)
      • getCreationDate

        @Nonnull
        public java.lang.Long getCreationDate()
        Get creationDate
        Returns:
        creationDate
      • setCreationDate

        public void setCreationDate​(@Nonnull
                                    java.lang.Long creationDate)
      • includeInSnippet

        @Deprecated
        public FeatureFlag includeInSnippet​(@Nullable
                                            java.lang.Boolean includeInSnippet)
        Deprecated.
      • getIncludeInSnippet

        @Deprecated
        @Nullable
        public java.lang.Boolean getIncludeInSnippet()
        Deprecated.
        Deprecated, use <code>clientSideAvailability</code>. Whether this flag should be made available to the client-side JavaScript SDK
        Returns:
        includeInSnippet
      • setIncludeInSnippet

        @Deprecated
        public void setIncludeInSnippet​(@Nullable
                                        java.lang.Boolean includeInSnippet)
        Deprecated.
      • getClientSideAvailability

        @Nullable
        public ClientSideAvailability getClientSideAvailability()
        Get clientSideAvailability
        Returns:
        clientSideAvailability
      • setClientSideAvailability

        public void setClientSideAvailability​(@Nullable
                                              ClientSideAvailability clientSideAvailability)
      • getVariations

        @Nonnull
        public java.util.List<Variation> getVariations()
        An array of possible variations for the flag
        Returns:
        variations
      • setVariations

        public void setVariations​(@Nonnull
                                  java.util.List<Variation> variations)
      • temporary

        public FeatureFlag temporary​(@Nonnull
                                     java.lang.Boolean temporary)
      • getTemporary

        @Nonnull
        public java.lang.Boolean getTemporary()
        Whether the flag is a temporary flag
        Returns:
        temporary
      • setTemporary

        public void setTemporary​(@Nonnull
                                 java.lang.Boolean temporary)
      • tags

        public FeatureFlag tags​(@Nonnull
                                java.util.List<java.lang.String> tags)
      • addTagsItem

        public FeatureFlag addTagsItem​(java.lang.String tagsItem)
      • getTags

        @Nonnull
        public java.util.List<java.lang.String> getTags()
        Tags for the feature flag
        Returns:
        tags
      • setTags

        public void setTags​(@Nonnull
                            java.util.List<java.lang.String> tags)
      • links

        public FeatureFlag links​(@Nonnull
                                 java.util.Map<java.lang.String,​Link> links)
      • putLinksItem

        public FeatureFlag 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​(@Nonnull
                             java.util.Map<java.lang.String,​Link> links)
      • maintainerId

        public FeatureFlag maintainerId​(@Nullable
                                        java.lang.String maintainerId)
      • getMaintainerId

        @Nullable
        public java.lang.String getMaintainerId()
        Associated maintainerId for the feature flag
        Returns:
        maintainerId
      • setMaintainerId

        public void setMaintainerId​(@Nullable
                                    java.lang.String maintainerId)
      • getMaintainer

        @Nullable
        public MemberSummary getMaintainer()
        Get maintainer
        Returns:
        maintainer
      • setMaintainer

        public void setMaintainer​(@Nullable
                                  MemberSummary maintainer)
      • maintainerTeamKey

        public FeatureFlag maintainerTeamKey​(@Nullable
                                             java.lang.String maintainerTeamKey)
      • getMaintainerTeamKey

        @Nullable
        public java.lang.String getMaintainerTeamKey()
        The key of the associated team that maintains this feature flag
        Returns:
        maintainerTeamKey
      • setMaintainerTeamKey

        public void setMaintainerTeamKey​(@Nullable
                                         java.lang.String maintainerTeamKey)
      • getMaintainerTeam

        @Nullable
        public MaintainerTeam getMaintainerTeam()
        Get maintainerTeam
        Returns:
        maintainerTeam
      • setMaintainerTeam

        public void setMaintainerTeam​(@Nullable
                                      MaintainerTeam maintainerTeam)
      • goalIds

        @Deprecated
        public FeatureFlag goalIds​(@Nullable
                                   java.util.List<java.lang.String> goalIds)
        Deprecated.
      • addGoalIdsItem

        public FeatureFlag addGoalIdsItem​(java.lang.String goalIdsItem)
      • getGoalIds

        @Deprecated
        @Nullable
        public java.util.List<java.lang.String> getGoalIds()
        Deprecated.
        Deprecated, use <code>experiments</code> instead
        Returns:
        goalIds
      • setGoalIds

        @Deprecated
        public void setGoalIds​(@Nullable
                               java.util.List<java.lang.String> goalIds)
        Deprecated.
      • getExperiments

        @Nonnull
        public ExperimentInfoRep getExperiments()
        Get experiments
        Returns:
        experiments
      • setExperiments

        public void setExperiments​(@Nonnull
                                   ExperimentInfoRep experiments)
      • customProperties

        public FeatureFlag customProperties​(@Nonnull
                                            java.util.Map<java.lang.String,​CustomProperty> customProperties)
      • putCustomPropertiesItem

        public FeatureFlag putCustomPropertiesItem​(java.lang.String key,
                                                   CustomProperty customPropertiesItem)
      • getCustomProperties

        @Nonnull
        public java.util.Map<java.lang.String,​CustomProperty> getCustomProperties()
        Get customProperties
        Returns:
        customProperties
      • setCustomProperties

        public void setCustomProperties​(@Nonnull
                                        java.util.Map<java.lang.String,​CustomProperty> customProperties)
      • archived

        public FeatureFlag archived​(@Nonnull
                                    java.lang.Boolean archived)
      • getArchived

        @Nonnull
        public java.lang.Boolean getArchived()
        Boolean indicating if the feature flag is archived
        Returns:
        archived
      • setArchived

        public void setArchived​(@Nonnull
                                java.lang.Boolean archived)
      • archivedDate

        public FeatureFlag archivedDate​(@Nullable
                                        java.lang.Long archivedDate)
      • getArchivedDate

        @Nullable
        public java.lang.Long getArchivedDate()
        Get archivedDate
        Returns:
        archivedDate
      • setArchivedDate

        public void setArchivedDate​(@Nullable
                                    java.lang.Long archivedDate)
      • deprecated

        public FeatureFlag deprecated​(@Nullable
                                      java.lang.Boolean deprecated)
      • getDeprecated

        @Nullable
        public java.lang.Boolean getDeprecated()
        Boolean indicating if the feature flag is deprecated
        Returns:
        deprecated
      • setDeprecated

        public void setDeprecated​(@Nullable
                                  java.lang.Boolean deprecated)
      • deprecatedDate

        public FeatureFlag deprecatedDate​(@Nullable
                                          java.lang.Long deprecatedDate)
      • getDeprecatedDate

        @Nullable
        public java.lang.Long getDeprecatedDate()
        Get deprecatedDate
        Returns:
        deprecatedDate
      • setDeprecatedDate

        public void setDeprecatedDate​(@Nullable
                                      java.lang.Long deprecatedDate)
      • getDefaults

        @Nullable
        public Defaults getDefaults()
        Get defaults
        Returns:
        defaults
      • setDefaults

        public void setDefaults​(@Nullable
                                Defaults defaults)
      • purpose

        public FeatureFlag purpose​(@Nullable
                                   java.lang.String purpose)
      • getPurpose

        @Nullable
        public java.lang.String getPurpose()
        Get purpose
        Returns:
        purpose
      • setPurpose

        public void setPurpose​(@Nullable
                               java.lang.String purpose)
      • getMigrationSettings

        @Nullable
        public FlagMigrationSettingsRep getMigrationSettings()
        Get migrationSettings
        Returns:
        migrationSettings
      • getEnvironments

        @Nullable
        public java.util.Map<java.lang.String,​FeatureFlagConfig> getEnvironments()
        Details on the environments for this flag. Only returned if the request is filtered by environment, using the <code>filterEnv</code> query parameter.
        Returns:
        environments
      • setEnvironments

        public void setEnvironments​(@Nullable
                                    java.util.Map<java.lang.String,​FeatureFlagConfig> environments)
      • putAdditionalProperty

        public FeatureFlag 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 FeatureFlag 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 FeatureFlag
      • fromJson

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

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