Skip to content

Latest commit

 

History

History
51 lines (42 loc) · 3.59 KB

UserSegment.md

File metadata and controls

51 lines (42 loc) · 3.59 KB

UserSegment

Properties

Name Type Description Notes
name str A human-friendly name for the segment.
description str A description of the segment's purpose. Defaults to <code>null</code> and is omitted in the response if not provided. [optional]
tags List[str] Tags for the segment. Defaults to an empty array.
creation_date int
last_modified_date int
key str A unique key used to reference the segment
included List[str] 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]
excluded List[str] 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]
included_contexts List[SegmentTarget] [optional]
excluded_contexts List[SegmentTarget] [optional]
links Dict[str, Link] The location and content type of related resources
rules List[UserSegmentRule] An array of the targeting rules for this segment.
version int Version of the segment
deleted bool Whether the segment has been deleted
access Access [optional]
flags List[FlagListingRep] A list of flags targeting this segment. Only included when getting a single segment, using the <code>getSegment</code> endpoint. [optional]
unbounded bool 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]
unbounded_context_kind str For big segments, the targeted context kind. [optional]
generation int For big segments, how many times this segment has been created.
unbounded_metadata SegmentMetadata [optional]
external str The external data store backing this segment. Only applies to synced segments. [optional]
external_link str The URL for the external data store backing this segment. Only applies to synced segments. [optional]
import_in_progress bool Whether an import is currently in progress for the specified segment. Only applies to big segments. [optional]

Example

from launchdarkly_api.models.user_segment import UserSegment

# TODO update the JSON string below
json = "{}"
# create an instance of UserSegment from a JSON string
user_segment_instance = UserSegment.from_json(json)
# print the JSON string representation of the object
print(UserSegment.to_json())

# convert the object into a dict
user_segment_dict = user_segment_instance.to_dict()
# create an instance of UserSegment from a dict
user_segment_from_dict = UserSegment.from_dict(user_segment_dict)

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