Class JourneySegment

java.lang.Object
com.mypurecloud.sdk.v2.model.JourneySegment
All Implemented Interfaces:
Serializable

public class JourneySegment extends Object implements Serializable
JourneySegment
See Also:
  • Constructor Details

    • JourneySegment

      public JourneySegment()
    • JourneySegment

      public JourneySegment(Boolean initWithEmptyList)
  • Method Details

    • id

      public JourneySegment id(String id)
      The ID of the segment.
    • getId

      public String getId()
    • setId

      public void setId(String id)
    • isActive

      public JourneySegment isActive(Boolean isActive)
      Whether or not the segment is active.
    • getIsActive

      public Boolean getIsActive()
    • setIsActive

      public void setIsActive(Boolean isActive)
    • displayName

      public JourneySegment displayName(String displayName)
      The display name of the segment.
    • getDisplayName

      public String getDisplayName()
    • setDisplayName

      public void setDisplayName(String displayName)
    • version

      public JourneySegment version(Integer version)
      The version of the segment.
    • getVersion

      public Integer getVersion()
    • setVersion

      public void setVersion(Integer version)
    • description

      public JourneySegment description(String description)
      A description of the segment.
    • getDescription

      public String getDescription()
    • setDescription

      public void setDescription(String description)
    • color

      public JourneySegment color(String color)
      The hexadecimal color value of the segment.
    • getColor

      public String getColor()
    • setColor

      public void setColor(String color)
    • scope

      The target entity that a segment applies to.
    • getScope

      public JourneySegment.ScopeEnum getScope()
    • setScope

      public void setScope(JourneySegment.ScopeEnum scope)
    • shouldDisplayToAgent

      public JourneySegment shouldDisplayToAgent(Boolean shouldDisplayToAgent)
      Whether or not the segment should be displayed to agent/supervisor users.
    • getShouldDisplayToAgent

      public Boolean getShouldDisplayToAgent()
    • setShouldDisplayToAgent

      public void setShouldDisplayToAgent(Boolean shouldDisplayToAgent)
    • context

      public JourneySegment context(Context context)
      The context of the segment.
    • getContext

      public Context getContext()
    • setContext

      public void setContext(Context context)
    • journey

      public JourneySegment journey(Journey journey)
      The pattern of rules defining the segment.
    • getJourney

      public Journey getJourney()
    • setJourney

      public void setJourney(Journey journey)
    • externalSegment

      public JourneySegment externalSegment(ExternalSegment externalSegment)
      Details of an entity corresponding to this segment in an external system.
    • getExternalSegment

      public ExternalSegment getExternalSegment()
    • setExternalSegment

      public void setExternalSegment(ExternalSegment externalSegment)
    • assignmentExpirationDays

      public JourneySegment assignmentExpirationDays(Integer assignmentExpirationDays)
      Time, in days, from when the segment is assigned until it is automatically unassigned.
    • getAssignmentExpirationDays

      public Integer getAssignmentExpirationDays()
    • setAssignmentExpirationDays

      public void setAssignmentExpirationDays(Integer assignmentExpirationDays)
    • getSelfUri

      public String getSelfUri()
    • createdDate

      public JourneySegment createdDate(Date createdDate)
      Timestamp indicating when the segment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getCreatedDate

      public Date getCreatedDate()
    • setCreatedDate

      public void setCreatedDate(Date createdDate)
    • modifiedDate

      public JourneySegment modifiedDate(Date modifiedDate)
      Timestamp indicating when the segment was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
    • getModifiedDate

      public Date getModifiedDate()
    • setModifiedDate

      public void setModifiedDate(Date modifiedDate)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object