Package com.launchdarkly.api.model

Class UserSegment

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-07-11T22:46:03.646077Z[Etc/UTC]")
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_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_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_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​(java.lang.String name)

      • getName

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

      • setName

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

      • description

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

      • getDescription

        @Nullable
public java.lang.String getDescription()
        A description of the segment's purpose
        Returns:
        description

      • setDescription

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

      • tags

        public UserSegment tags​(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
        Returns:
        tags

      • setTags

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

      • creationDate

        public UserSegment creationDate​(java.lang.Long creationDate)

      • getCreationDate

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

      • setCreationDate

        public void setCreationDate​(java.lang.Long creationDate)

      • key

        public UserSegment key​(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​(java.lang.String key)

      • included

        public UserSegment included​(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 user keys for included users. Included users are always segment members, regardless of segment rules. For Big Segments this array is either empty or omitted.
        Returns:
        included

      • setIncluded

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

      • excluded

        public UserSegment excluded​(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 user keys for excluded users. Segment rules bypass excluded users, so they will never be included based on rules. Excluded users may still be included explicitly. This value is omitted for Big Segments.
        Returns:
        excluded

      • setExcluded

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

      • links

        public UserSegment links​(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()
        Links to other resources within the API. Includes the URL and content type of those resources.
        Returns:
        links

      • setLinks

        public void setLinks​(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​(java.util.List<UserSegmentRule> rules)

      • version

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

      • getVersion

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

      • setVersion

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

      • deleted

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

      • getDeleted

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

      • setDeleted

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

      • getAccess

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

      • setAccess

        public void setAccess​(Access access)

      • getFlags

        @Nullable
public java.util.List<FlagListingRep> getFlags()
        Get flags
        Returns:
        flags

      • setFlags

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

      • unbounded

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

      • getUnbounded

        @Nullable
public java.lang.Boolean getUnbounded()
        Whether this is a standard segment (false) or a Big Segment (true)
        Returns:
        unbounded

      • setUnbounded

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

      • generation

        public UserSegment generation​(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​(java.lang.Integer generation)

      • getUnboundedMetadata

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

      • setUnboundedMetadata

        public void setUnboundedMetadata​(SegmentMetadata unboundedMetadata)

      • external

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

      • getExternal

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

      • setExternal

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

      • externalLink

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

      • getExternalLink

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

      • setExternalLink

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

      • importInProgress

        public UserSegment importInProgress​(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​(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.

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