Uses of Class
com.mypurecloud.sdk.v2.model.JourneySegment

Packages that use JourneySegment

Package	Description
com.mypurecloud.sdk.v2.api
com.mypurecloud.sdk.v2.model

Uses of JourneySegment in com.mypurecloud.sdk.v2.api

Methods in com.mypurecloud.sdk.v2.api that return JourneySegment

Modifier and Type	Method	Description
JourneySegment	JourneyApi.getJourneySegment(GetJourneySegmentRequest request)	Retrieve a single segment.
JourneySegment	JourneyApi.getJourneySegment(String segmentId)	Retrieve a single segment.
JourneySegment	JourneyApi.patchJourneySegment(PatchJourneySegmentRequest request)	Update a segment.
JourneySegment	JourneyApi.patchJourneySegment(String segmentId, PatchSegment body)	Update a segment.
JourneySegment	JourneyApi.postJourneySegments(PostJourneySegmentsRequest request)	Create a segment.
JourneySegment	JourneyApi.postJourneySegments(JourneySegmentRequest body)	Create a segment.

Methods in com.mypurecloud.sdk.v2.api that return types with arguments of type JourneySegment

Modifier and Type	Method	Description
ApiResponse<JourneySegment>	JourneyApi.getJourneySegment(ApiRequest<Void> request)	Retrieve a single segment.
Future<JourneySegment>	JourneyApiAsync.getJourneySegmentAsync(GetJourneySegmentRequest request, AsyncApiCallback<JourneySegment> callback)	Retrieve a single segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.getJourneySegmentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Retrieve a single segment.
ApiResponse<JourneySegment>	JourneyApi.getJourneySegmentWithHttpInfo(String segmentId)	Retrieve a single segment.
ApiResponse<JourneySegment>	JourneyApi.patchJourneySegment(ApiRequest<PatchSegment> request)	Update a segment.
Future<JourneySegment>	JourneyApiAsync.patchJourneySegmentAsync(PatchJourneySegmentRequest request, AsyncApiCallback<JourneySegment> callback)	Update a segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.patchJourneySegmentAsync(ApiRequest<PatchSegment> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Update a segment.
ApiResponse<JourneySegment>	JourneyApi.patchJourneySegmentWithHttpInfo(String segmentId, PatchSegment body)	Update a segment.
ApiResponse<JourneySegment>	JourneyApi.postJourneySegments(ApiRequest<JourneySegmentRequest> request)	Create a segment.
Future<JourneySegment>	JourneyApiAsync.postJourneySegmentsAsync(PostJourneySegmentsRequest request, AsyncApiCallback<JourneySegment> callback)	Create a segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.postJourneySegmentsAsync(ApiRequest<JourneySegmentRequest> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Create a segment.
ApiResponse<JourneySegment>	JourneyApi.postJourneySegmentsWithHttpInfo(JourneySegmentRequest body)	Create a segment.

Method parameters in com.mypurecloud.sdk.v2.api with type arguments of type JourneySegment

Modifier and Type	Method	Description
Future<JourneySegment>	JourneyApiAsync.getJourneySegmentAsync(GetJourneySegmentRequest request, AsyncApiCallback<JourneySegment> callback)	Retrieve a single segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.getJourneySegmentAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Retrieve a single segment.
Future<JourneySegment>	JourneyApiAsync.patchJourneySegmentAsync(PatchJourneySegmentRequest request, AsyncApiCallback<JourneySegment> callback)	Update a segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.patchJourneySegmentAsync(ApiRequest<PatchSegment> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Update a segment.
Future<JourneySegment>	JourneyApiAsync.postJourneySegmentsAsync(PostJourneySegmentsRequest request, AsyncApiCallback<JourneySegment> callback)	Create a segment.
Future<ApiResponse<JourneySegment>>	JourneyApiAsync.postJourneySegmentsAsync(ApiRequest<JourneySegmentRequest> request, AsyncApiCallback<ApiResponse<JourneySegment>> callback)	Create a segment.

Uses of JourneySegment in com.mypurecloud.sdk.v2.model

Methods in com.mypurecloud.sdk.v2.model that return JourneySegment

Modifier and Type	Method	Description
JourneySegment	JourneySegment.assignmentExpirationDays(Integer assignmentExpirationDays)	Time, in days, from when the segment is assigned until it is automatically unassigned.
JourneySegment	JourneySegment.color(String color)	The hexadecimal color value of the segment.
JourneySegment	JourneySegment.context(Context context)	The context of the segment.
JourneySegment	JourneySegment.createdDate(Date createdDate)	Timestamp indicating when the segment was created.
JourneySegment	JourneySegment.description(String description)	A description of the segment.
JourneySegment	JourneySegment.displayName(String displayName)	The display name of the segment.
JourneySegment	JourneySegment.externalSegment(ExternalSegment externalSegment)	Details of an entity corresponding to this segment in an external system.
JourneySegment	JourneySegment.id(String id)	The ID of the segment.
JourneySegment	JourneySegment.isActive(Boolean isActive)	Whether or not the segment is active.
JourneySegment	JourneySegment.journey(Journey journey)	The pattern of rules defining the segment.
JourneySegment	JourneySegment.modifiedDate(Date modifiedDate)	Timestamp indicating when the segment was last updated.
JourneySegment	JourneySegment.scope(JourneySegment.ScopeEnum scope)	The target entity that a segment applies to.
JourneySegment	JourneySegment.shouldDisplayToAgent(Boolean shouldDisplayToAgent)	Whether or not the segment should be displayed to agent/supervisor users.
JourneySegment	JourneySegment.version(Integer version)	The version of the segment.

Methods in com.mypurecloud.sdk.v2.model that return types with arguments of type JourneySegment

Modifier and Type	Method	Description
List<JourneySegment>	SegmentListing.getEntities()

Method parameters in com.mypurecloud.sdk.v2.model with type arguments of type JourneySegment

Modifier and Type	Method	Description
SegmentListing	SegmentListing.entities(List<JourneySegment> entities)
void	SegmentListing.setEntities(List<JourneySegment> entities)