Package com.launchdarkly.api.model

Class Rule

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

    • Field Detail

      • SERIALIZED_NAME_ID

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

      • SERIALIZED_NAME_DISABLED

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

      • SERIALIZED_NAME_VARIATION

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

      • SERIALIZED_NAME_ROLLOUT

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

      • SERIALIZED_NAME_CLAUSES

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

      • SERIALIZED_NAME_TRACK_EVENTS

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

      • SERIALIZED_NAME_DESCRIPTION

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

      • SERIALIZED_NAME_REF

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

      • Rule

        public Rule()

    • Method Detail

      • id

        public Rule id​(@Nullable
               java.lang.String id)

      • getId

        @Nullable
public java.lang.String getId()
        The flag rule ID
        Returns:
        id

      • setId

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

      • disabled

        public Rule disabled​(@Nullable
                     java.lang.Boolean disabled)

      • getDisabled

        @Nullable
public java.lang.Boolean getDisabled()
        Whether the rule is disabled
        Returns:
        disabled

      • setDisabled

        public void setDisabled​(@Nullable
                        java.lang.Boolean disabled)

      • variation

        public Rule variation​(@Nullable
                      java.lang.Integer variation)

      • getVariation

        @Nullable
public java.lang.Integer getVariation()
        The index of the variation, from the array of variations for this flag
        Returns:
        variation

      • setVariation

        public void setVariation​(@Nullable
                         java.lang.Integer variation)

      • rollout

        public Rule rollout​(@Nullable
                    Rollout rollout)

      • getRollout

        @Nullable
public Rollout getRollout()
        Get rollout
        Returns:
        rollout

      • setRollout

        public void setRollout​(@Nullable
                       Rollout rollout)

      • clauses

        public Rule clauses​(@Nonnull
                    java.util.List<Clause> clauses)

      • addClausesItem

        public Rule addClausesItem​(Clause clausesItem)

      • getClauses

        @Nonnull
public java.util.List<Clause> getClauses()
        An array of clauses used for individual targeting based on attributes
        Returns:
        clauses

      • setClauses

        public void setClauses​(@Nonnull
                       java.util.List<Clause> clauses)

      • trackEvents

        public Rule trackEvents​(@Nonnull
                        java.lang.Boolean trackEvents)

      • getTrackEvents

        @Nonnull
public java.lang.Boolean getTrackEvents()
        Whether LaunchDarkly tracks events for this rule
        Returns:
        trackEvents

      • setTrackEvents

        public void setTrackEvents​(@Nonnull
                           java.lang.Boolean trackEvents)

      • description

        public Rule description​(@Nullable
                        java.lang.String description)

      • getDescription

        @Nullable
public java.lang.String getDescription()
        The rule description
        Returns:
        description

      • setDescription

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

      • ref

        public Rule ref​(@Nullable
                java.lang.String ref)

      • getRef

        @Nullable
public java.lang.String getRef()
        Get ref
        Returns:
        ref

      • setRef

        public void setRef​(@Nullable
                   java.lang.String ref)

      • putAdditionalProperty

        public Rule 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 Rule 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 Rule

      • fromJson

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

      • toJson

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