Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.62 KB

ContextInstanceSegmentMembership.md

File metadata and controls

34 lines (28 loc) · 1.62 KB

LaunchDarklyApi::ContextInstanceSegmentMembership

Properties

Name Type Description Notes
name String A human-friendly name for the segment
key String A unique key used to reference the segment
description String A description of the segment's purpose
unbounded Boolean Whether this is an unbounded segment. Unbounded segments, also called big segments, may be list-based segments with more than 15,000 entries, or synced segments.
external String If the segment is a synced segment, the name of the external source
is_member Boolean Whether the context is a member of this segment, either by explicit inclusion or by rule matching
is_individually_targeted Boolean Whether the context is explicitly included in this segment
is_rule_targeted Boolean Whether the context is captured by this segment's rules. The value of this field is undefined if the context is also explicitly included (<code>isIndividuallyTargeted</code> is <code>true</code>).
_links Hash<String, Link> The location and content type of related resources

Example

require 'launchdarkly_api'

instance = LaunchDarklyApi::ContextInstanceSegmentMembership.new(
  name: Segment Name,
  key: segment-key-123abc,
  description: Segment description,
  unbounded: false,
  external: https://amplitude.com/myCohort,
  is_member: true,
  is_individually_targeted: true,
  is_rule_targeted: false,
  _links: null
)