Class FeatureFlagBody


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

      • SERIALIZED_NAME_NAME

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

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

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

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

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

        public static final java.lang.String SERIALIZED_NAME_INITIAL_PREREQUISITES
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_IS_FLAG_ON

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

      • FeatureFlagBody

        public FeatureFlagBody()
    • Method Detail

      • 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)
      • 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)
      • description

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

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

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

        @Deprecated
        public FeatureFlagBody 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. Defaults to <code>false</code>.
        Returns:
        includeInSnippet
      • setIncludeInSnippet

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

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

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

        @Nullable
        public java.util.List<Variation> getVariations()
        An array of possible variations for the flag. The variation values must be unique. If omitted, two boolean variations of <code>true</code> and <code>false</code> will be used.
        Returns:
        variations
      • setVariations

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

        public FeatureFlagBody temporary​(@Nullable
                                         java.lang.Boolean temporary)
      • getTemporary

        @Nullable
        public java.lang.Boolean getTemporary()
        Whether the flag is a temporary flag. Defaults to <code>true</code>.
        Returns:
        temporary
      • setTemporary

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

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

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

        @Nullable
        public java.util.List<java.lang.String> getTags()
        Tags for the feature flag. Defaults to an empty array.
        Returns:
        tags
      • setTags

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

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

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

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

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

        @Nullable
        public MigrationSettingsPost getMigrationSettings()
        Get migrationSettings
        Returns:
        migrationSettings
      • setMigrationSettings

        public void setMigrationSettings​(@Nullable
                                         MigrationSettingsPost migrationSettings)
      • maintainerId

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

        @Nullable
        public java.lang.String getMaintainerId()
        The ID of the member who maintains this feature flag
        Returns:
        maintainerId
      • setMaintainerId

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

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

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

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

        @Nullable
        public java.util.List<FlagPrerequisitePost> getInitialPrerequisites()
        Initial set of prerequisite flags for all environments
        Returns:
        initialPrerequisites
      • setInitialPrerequisites

        public void setInitialPrerequisites​(@Nullable
                                            java.util.List<FlagPrerequisitePost> initialPrerequisites)
      • isFlagOn

        public FeatureFlagBody isFlagOn​(@Nullable
                                        java.lang.Boolean isFlagOn)
      • getIsFlagOn

        @Nullable
        public java.lang.Boolean getIsFlagOn()
        Whether to automatically turn the flag on across all environments at creation. Defaults to <code>false</code>.
        Returns:
        isFlagOn
      • setIsFlagOn

        public void setIsFlagOn​(@Nullable
                                java.lang.Boolean isFlagOn)
      • putAdditionalProperty

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

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

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