Newer Version Available

This content describes an older version of this product. View Latest

ConnectApi.CdpSegmentInput

Segment input.
Property Type Description Required or Optional Available Version
additionalMetadata Map<String, String> Map of additional metadata. Optional for creating a segment

Not supported for updating a segment

55.0
dataSpace String Segment data space. Optional 57.0
description String Segment description. Optional 55.0
developerName String Segment developer name. Required for creating a segment

Not supported for updating a segment

55.0
displayName String Segment display name. Optional 57.0
includeDbt ConnectApi.​CdpSegment​DbtInput Segment data build tool. Required 55.0
publishSchedule ConnectApi.​PublishSchedule Publish refresh schedule. Values are:
  • One—Refreshes every hour. Used to rapidly publish UI and DBT-based segments.
  • Four—Refreshes every four hours. Used to rapidly publish UI and DBT-based segments.
  • Twelve—Refreshes every twelve hours.
  • TwentyFour—Refreshes every twenty-four hours.
Optional 55.0
publishSchedule​EndDate String Date indicating the end of the publish schedule. Optional if publishSchedule isn’t specified 55.0
publishSchedule​StartDateTime String Datetime indicating the start of the publish schedule. Optional if publishSchedule isn’t specified 55.0
segmentOnApiName String API name of the SegmentOn entity. Optional 57.0
segmentType ConnectApi.​SegmentType Type of segment. Value is:
  • Dbt—Data build tool
After a segment is created, the segment type can’t be changed.
Required for creating a segment

Not supported for updating a segment

55.0