Class UserSegment


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2021-12-03T20:58:35.619656Z[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
    • 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()
        Included users are always segment members, regardless of segment rules. For Big Segments this array is either empty or omitted entirely.
        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()
        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()
        Get links
        Returns:
        links
      • setLinks

        public void setLinks​(java.util.Map<java.lang.String,​Link> links)
      • getRules

        @Nonnull
        public java.util.List<UserSegmentRule> getRules()
        Get rules
        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()
        Get version
        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()
        Get deleted
        Returns:
        deleted
      • setDeleted

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

        @Nullable
        public AccessRep getAccess()
        Get access
        Returns:
        access
      • setAccess

        public void setAccess​(AccessRep 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()
        Get unbounded
        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()
        Get generation
        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()
        Get external
        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()
        Get externalLink
        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()
        Get importInProgress
        Returns:
        importInProgress
      • setImportInProgress

        public void setImportInProgress​(java.lang.Boolean importInProgress)
      • 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