UserSegment.md

UserSegment

Properties

Name	Type	Description	Notes
name	string	A human-friendly name for the segment.	[default to undefined]
description	string	A description of the segment&#39;s purpose. Defaults to <code>null</code> and is omitted in the response if not provided.	[optional] [default to undefined]
tags	Array<string>	Tags for the segment. Defaults to an empty array.	[default to undefined]
creationDate	number		[default to undefined]
lastModifiedDate	number		[default to undefined]
key	string	A unique key used to reference the segment	[default to undefined]
included	Array<string>	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.	[optional] [default to undefined]
excluded	Array<string>	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.	[optional] [default to undefined]
includedContexts	Array<SegmentTarget>		[optional] [default to undefined]
excludedContexts	Array<SegmentTarget>		[optional] [default to undefined]
_links	{ [key: string]: Link; }	The location and content type of related resources	[default to undefined]
rules	Array<UserSegmentRule>	An array of the targeting rules for this segment.	[default to undefined]
version	number	Version of the segment	[default to undefined]
deleted	boolean	Whether the segment has been deleted	[default to undefined]
_access	Access		[optional] [default to undefined]
_flags	Array<FlagListingRep>	A list of flags targeting this segment. Only included when getting a single segment, using the <code>getSegment</code> endpoint.	[optional] [default to undefined]
unbounded	boolean	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.	[optional] [default to undefined]
unboundedContextKind	string	For big segments, the targeted context kind.	[optional] [default to undefined]
generation	number	For big segments, how many times this segment has been created.	[default to undefined]
_unboundedMetadata	SegmentMetadata		[optional] [default to undefined]
_external	string	The external data store backing this segment. Only applies to synced segments.	[optional] [default to undefined]
_externalLink	string	The URL for the external data store backing this segment. Only applies to synced segments.	[optional] [default to undefined]
_importInProgress	boolean	Whether an import is currently in progress for the specified segment. Only applies to big segments.	[optional] [default to undefined]

Example

import { UserSegment } from 'launchdarkly-api-typescript';

const instance: UserSegment = {
    name,
    description,
    tags,
    creationDate,
    lastModifiedDate,
    key,
    included,
    excluded,
    includedContexts,
    excludedContexts,
    _links,
    rules,
    version,
    deleted,
    _access,
    _flags,
    unbounded,
    unboundedContextKind,
    generation,
    _unboundedMetadata,
    _external,
    _externalLink,
    _importInProgress,
};

[Back to Model list] [Back to API list] [Back to README]