UserSegment.md

LaunchDarklyApi::UserSegment

Properties

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

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::UserSegment.new(
  name: Example segment,
  description: Bundle our sample customers together,
  tags: ["testing"],
  creation_date: null,
  last_modified_date: null,
  key: segment-key-123abc,
  included: ["user-key-123abc"],
  excluded: ["user-key-123abc"],
  included_contexts: null,
  excluded_contexts: null,
  _links: null,
  rules: [{"_id":"1234a56b7c89d012345e678f","clauses":[{"_id":"12ab3c45de678910fab12345","attribute":"email","negate":false,"op":"endsWith","values":[".edu"]}]}],
  version: 1,
  deleted: false,
  _access: null,
  _flags: null,
  unbounded: false,
  unbounded_context_kind: null,
  generation: null,
  _unbounded_metadata: null,
  _external: amplitude,
  _external_link: https://analytics.amplitude.com/org/1234/cohort/123abc,
  _import_in_progress: false
)