Skip to content

AssociatedSegment

Source code in docs_src/capo_customer_profiles/types/associated_segment.py 
13
14
15
16
17
18
19
20
21
class AssociatedSegment(TypedDict, closed=True):
    segment_name: NotRequired["capo_customer_profiles.types.name.name"]
    """<p>The unique name of the segment definition. </p>"""
    status: NotRequired[
        "capo_customer_profiles.types.event_subscription_segment_status.EventSubscriptionSegmentStatus"
    ]
    """<p>The subscription status of the segment. The following are valid values: </p> <ul> <li> <p> <b>STARTING</b>: The segment is being prepared to publish membership events. </p> </li> <li> <p> <b>RUNNING</b>: The segment is actively publishing membership events to the stream. </p> </li> <li> <p> <b>STOPPED</b>: The segment has stopped publishing membership events. </p> </li> <li> <p> <b>FAILED</b>: The segment failed to publish membership events. </p> </li> </ul>"""
    message: NotRequired["capo_customer_profiles.types.string1_to1000.string1To1000"]
    """<p>An optional message providing context, such as a failure reason. </p>"""

message instance-attribute 

message: NotRequired[string1To1000]

An optional message providing context, such as a failure reason.

segment_name instance-attribute 

segment_name: NotRequired[name]

The unique name of the segment definition.

status instance-attribute 

status: NotRequired[EventSubscriptionSegmentStatus]

The subscription status of the segment. The following are valid values:

  • STARTING: The segment is being prepared to publish membership events.

  • RUNNING: The segment is actively publishing membership events to the stream.

  • STOPPED: The segment has stopped publishing membership events.

  • FAILED: The segment failed to publish membership events.