Package com.launchdarkly.api.model

Class UserSegment

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

    • Field Detail

      • SERIALIZED_NAME_NAME

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

      • SERIALIZED_NAME_DESCRIPTION

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

      • SERIALIZED_NAME_TAGS

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

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

      • SERIALIZED_NAME_KEY

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

      • SERIALIZED_NAME_INCLUDED

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

      • SERIALIZED_NAME_EXCLUDED

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

      • SERIALIZED_NAME_INCLUDED_CONTEXTS

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

      • SERIALIZED_NAME_EXCLUDED_CONTEXTS

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

      • SERIALIZED_NAME_LINKS

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

      • SERIALIZED_NAME_RULES

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

      • SERIALIZED_NAME_VERSION

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

      • SERIALIZED_NAME_DELETED

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

      • SERIALIZED_NAME_ACCESS

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

      • SERIALIZED_NAME_FLAGS

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

      • SERIALIZED_NAME_UNBOUNDED

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

      • SERIALIZED_NAME_UNBOUNDED_CONTEXT_KIND

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

      • SERIALIZED_NAME_GENERATION

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

      • SERIALIZED_NAME_UNBOUNDED_METADATA

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

      • SERIALIZED_NAME_EXTERNAL

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

      • SERIALIZED_NAME_EXTERNAL_LINK

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

      • SERIALIZED_NAME_IMPORT_IN_PROGRESS

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

      • UserSegment

        public UserSegment()

    • Method Detail

      • name

        public UserSegment name​(@Nonnull
                        java.lang.String name)

      • getName

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

      • setName

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

      • description

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

      • getDescription

        @Nullable
public java.lang.String getDescription()
        A description of the segment's purpose. Defaults to <code>null</code> and is omitted in the response if not provided.
        Returns:
        description

      • setDescription

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

      • tags

        public UserSegment tags​(@Nonnull
                        java.util.List<java.lang.String> tags)

      • addTagsItem

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

      • getTags

        @Nonnull
public java.util.List<java.lang.String> getTags()
        Tags for the segment. Defaults to an empty array.
        Returns:
        tags

      • setTags

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

      • creationDate

        public UserSegment 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)

      • lastModifiedDate

        public UserSegment lastModifiedDate​(@Nonnull
                                    java.lang.Long lastModifiedDate)

      • getLastModifiedDate

        @Nonnull
public java.lang.Long getLastModifiedDate()
        Get lastModifiedDate
        Returns:
        lastModifiedDate

      • setLastModifiedDate

        public void setLastModifiedDate​(@Nonnull
                                java.lang.Long lastModifiedDate)

      • key

        public UserSegment key​(@Nonnull
                       java.lang.String key)

      • getKey

        @Nonnull
public java.lang.String getKey()
        A unique key used to reference the segment
        Returns:
        key

      • setKey

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

      • included

        public UserSegment included​(@Nullable
                            java.util.List<java.lang.String> included)

      • addIncludedItem

        public UserSegment addIncludedItem​(java.lang.String includedItem)

      • getIncluded

        @Nullable
public java.util.List<java.lang.String> getIncluded()
        An array of keys for included targets. Included individual targets are always segment members, regardless of segment rules. For list-based segments over 15,000 entries, also called big segments, this array is either empty or omitted.
        Returns:
        included

      • setIncluded

        public void setIncluded​(@Nullable
                        java.util.List<java.lang.String> included)

      • excluded

        public UserSegment excluded​(@Nullable
                            java.util.List<java.lang.String> excluded)

      • addExcludedItem

        public UserSegment addExcludedItem​(java.lang.String excludedItem)

      • getExcluded

        @Nullable
public java.util.List<java.lang.String> getExcluded()
        An array of keys for excluded targets. Segment rules bypass individual excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. This value is omitted for list-based segments over 15,000 entries, also called big segments.
        Returns:
        excluded

      • setExcluded

        public void setExcluded​(@Nullable
                        java.util.List<java.lang.String> excluded)

      • getIncludedContexts

        @Nullable
public java.util.List<SegmentTarget> getIncludedContexts()
        Get includedContexts
        Returns:
        includedContexts

      • setIncludedContexts

        public void setIncludedContexts​(@Nullable
                                java.util.List<SegmentTarget> includedContexts)

      • getExcludedContexts

        @Nullable
public java.util.List<SegmentTarget> getExcludedContexts()
        Get excludedContexts
        Returns:
        excludedContexts

      • setExcludedContexts

        public void setExcludedContexts​(@Nullable
                                java.util.List<SegmentTarget> excludedContexts)

      • links

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

      • putLinksItem

        public UserSegment 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)

      • getRules

        @Nonnull
public java.util.List<UserSegmentRule> getRules()
        An array of the targeting rules for this segment.
        Returns:
        rules

      • setRules

        public void setRules​(@Nonnull
                     java.util.List<UserSegmentRule> rules)

      • version

        public UserSegment version​(@Nonnull
                           java.lang.Integer version)

      • getVersion

        @Nonnull
public java.lang.Integer getVersion()
        Version of the segment
        Returns:
        version

      • setVersion

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

      • deleted

        public UserSegment deleted​(@Nonnull
                           java.lang.Boolean deleted)

      • getDeleted

        @Nonnull
public java.lang.Boolean getDeleted()
        Whether the segment has been deleted
        Returns:
        deleted

      • setDeleted

        public void setDeleted​(@Nonnull
                       java.lang.Boolean deleted)

      • getAccess

        @Nullable
public Access getAccess()
        Get access
        Returns:
        access

      • setAccess

        public void setAccess​(@Nullable
                      Access access)

      • getFlags

        @Nullable
public java.util.List<FlagListingRep> getFlags()
        A list of flags targeting this segment. Only included when getting a single segment, using the <code>getSegment</code> endpoint.
        Returns:
        flags

      • setFlags

        public void setFlags​(@Nullable
                     java.util.List<FlagListingRep> flags)

      • unbounded

        public UserSegment unbounded​(@Nullable
                             java.lang.Boolean unbounded)

      • getUnbounded

        @Nullable
public java.lang.Boolean getUnbounded()
        Whether this is a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. If omitted, the segment is a standard segment.
        Returns:
        unbounded

      • setUnbounded

        public void setUnbounded​(@Nullable
                         java.lang.Boolean unbounded)

      • unboundedContextKind

        public UserSegment unboundedContextKind​(@Nullable
                                        java.lang.String unboundedContextKind)

      • getUnboundedContextKind

        @Nullable
public java.lang.String getUnboundedContextKind()
        For big segments, the targeted context kind.
        Returns:
        unboundedContextKind

      • setUnboundedContextKind

        public void setUnboundedContextKind​(@Nullable
                                    java.lang.String unboundedContextKind)

      • generation

        public UserSegment generation​(@Nonnull
                              java.lang.Integer generation)

      • getGeneration

        @Nonnull
public java.lang.Integer getGeneration()
        For big segments, how many times this segment has been created.
        Returns:
        generation

      • setGeneration

        public void setGeneration​(@Nonnull
                          java.lang.Integer generation)

      • getUnboundedMetadata

        @Nullable
public SegmentMetadata getUnboundedMetadata()
        Get unboundedMetadata
        Returns:
        unboundedMetadata

      • setUnboundedMetadata

        public void setUnboundedMetadata​(@Nullable
                                 SegmentMetadata unboundedMetadata)

      • external

        public UserSegment external​(@Nullable
                            java.lang.String external)

      • getExternal

        @Nullable
public java.lang.String getExternal()
        The external data store backing this segment. Only applies to synced segments.
        Returns:
        external

      • setExternal

        public void setExternal​(@Nullable
                        java.lang.String external)

      • externalLink

        public UserSegment externalLink​(@Nullable
                                java.lang.String externalLink)

      • getExternalLink

        @Nullable
public java.lang.String getExternalLink()
        The URL for the external data store backing this segment. Only applies to synced segments.
        Returns:
        externalLink

      • setExternalLink

        public void setExternalLink​(@Nullable
                            java.lang.String externalLink)

      • importInProgress

        public UserSegment importInProgress​(@Nullable
                                    java.lang.Boolean importInProgress)

      • getImportInProgress

        @Nullable
public java.lang.Boolean getImportInProgress()
        Whether an import is currently in progress for the specified segment. Only applies to big segments.
        Returns:
        importInProgress

      • setImportInProgress

        public void setImportInProgress​(@Nullable
                                java.lang.Boolean importInProgress)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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