Package com.mypurecloud.sdk.v2.model

Class ReportingExportJobResponse

java.lang.Object

com.mypurecloud.sdk.v2.model.ReportingExportJobResponse

All Implemented Interfaces:

Serializable

public class ReportingExportJobResponse
extends Object
implements Serializable

ReportingExportJobResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReportingExportJobResponse.CsvDelimiterEnum	The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
static enum	ReportingExportJobResponse.DurationFormatEnum	Indicates the duration format for the exports
static enum	ReportingExportJobResponse.ExportErrorMessagesTypeEnum	The error message in case the export request failed
static enum	ReportingExportJobResponse.ExportFormatEnum	The requested format of the exported data
static enum	ReportingExportJobResponse.InnerEnum	Gets or Sets inner
static enum	ReportingExportJobResponse.StatusEnum	The current status of the export request
static enum	ReportingExportJobResponse.ViewTypeEnum	The type of view export job to be created

Constructor Summary

Constructors

Constructor	Description
ReportingExportJobResponse()
ReportingExportJobResponse(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ReportingExportJobResponse	chartColumns(List<ChartColumn> chartColumns)	The list of columns for which chart is going to be displayed in export
ReportingExportJobResponse	createdDateTime(Date createdDateTime)	The created date/time of the request.
ReportingExportJobResponse	csvDelimiter(ReportingExportJobResponse.CsvDelimiterEnum csvDelimiter)	The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
ReportingExportJobResponse	downloadUrl(String downloadUrl)	The url to download the request if it's status is completed
ReportingExportJobResponse	durationFormat(ReportingExportJobResponse.DurationFormatEnum durationFormat)	Indicates the duration format for the exports
ReportingExportJobResponse	emailErrorDescription(String emailErrorDescription)	The optional error message in case the export fail to email
ReportingExportJobResponse	emailStatuses(Map<String,ReportingExportJobResponse.InnerEnum> emailStatuses)	The status of individual email addresses as a map
ReportingExportJobResponse	enabled(Boolean enabled)
boolean	equals(Object o)
ReportingExportJobResponse	excludeEmptyRows(Boolean excludeEmptyRows)	Excludes empty rows from the exports
ReportingExportJobResponse	exportAllowedToRerun(Boolean exportAllowedToRerun)	Indicates whether the export run is allowed to rerun
ReportingExportJobResponse	exportErrorMessagesType(ReportingExportJobResponse.ExportErrorMessagesTypeEnum exportErrorMessagesType)	The error message in case the export request failed
ReportingExportJobResponse	exportFormat(ReportingExportJobResponse.ExportFormatEnum exportFormat)	The requested format of the exported data
ReportingExportJobResponse	filter(ViewFilter filter)	Filters to apply to create the view
List<ChartColumn>	getChartColumns()
Date	getCreatedDateTime()
ReportingExportJobResponse.CsvDelimiterEnum	getCsvDelimiter()
String	getDownloadUrl()
ReportingExportJobResponse.DurationFormatEnum	getDurationFormat()
String	getEmailErrorDescription()
Map<String,ReportingExportJobResponse.InnerEnum>	getEmailStatuses()
Boolean	getEnabled()
Boolean	getExcludeEmptyRows()
Boolean	getExportAllowedToRerun()
ReportingExportJobResponse.ExportErrorMessagesTypeEnum	getExportErrorMessagesType()
ReportingExportJobResponse.ExportFormatEnum	getExportFormat()
ViewFilter	getFilter()
Boolean	getHasCustomParticipantAttributes()
Boolean	getHasFormatDurations()
Boolean	getHasSplitByMedia()
Boolean	getHasSplitFilters()
Boolean	getHasSummaryRow()
String	getId()
Boolean	getIncludeDurationFormatInHeader()
String	getInterval()
String	getLocale()
Date	getModifiedDateTime()
String	getName()
Double	getPercentageComplete()
String	getPeriod()
Boolean	getRead()
List<String>	getRecipientEmails()
String	getRunId()
List<SelectedColumns>	getSelectedColumns()
String	getSelfUri()
ReportingExportJobResponse.StatusEnum	getStatus()
String	getTimeZone()
ReportingExportJobResponse.ViewTypeEnum	getViewType()
ReportingExportJobResponse	hasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)	Indicates if custom participant attributes will be exported
ReportingExportJobResponse	hasFormatDurations(Boolean hasFormatDurations)	Indicates if durations are formatted in hh:mm:ss format instead of ms
int	hashCode()
ReportingExportJobResponse	hasSplitByMedia(Boolean hasSplitByMedia)	Indicates if media type will be split in aggregate detail exports
ReportingExportJobResponse	hasSplitFilters(Boolean hasSplitFilters)	Indicates if filters will be split in aggregate detail exports
ReportingExportJobResponse	hasSummaryRow(Boolean hasSummaryRow)	Indicates if summary row needs to be present in exports
ReportingExportJobResponse	includeDurationFormatInHeader(Boolean includeDurationFormatInHeader)	Indicates whether to include selected duration format to the column headers
ReportingExportJobResponse	interval(String interval)	The time period used to limit the the exported data.
ReportingExportJobResponse	locale(String locale)	The locale use for localization of the exported data, i.e. en-us, es-mx
ReportingExportJobResponse	modifiedDateTime(Date modifiedDateTime)	The last modified date/time of the request.
ReportingExportJobResponse	name(String name)
ReportingExportJobResponse	percentageComplete(Double percentageComplete)	The percentage of the job that has completed processing
ReportingExportJobResponse	period(String period)	The Period of the request in which to break down the intervals.
ReportingExportJobResponse	read(Boolean read)	Indicates if the request has been marked as read
ReportingExportJobResponse	recipientEmails(List<String> recipientEmails)	The list of email recipients for the exports
ReportingExportJobResponse	runId(String runId)	The unique run id of the export schedule execute
ReportingExportJobResponse	selectedColumns(List<SelectedColumns> selectedColumns)	The list of ordered selected columns from the export view by the user
void	setChartColumns(List<ChartColumn> chartColumns)
void	setCreatedDateTime(Date createdDateTime)
void	setCsvDelimiter(ReportingExportJobResponse.CsvDelimiterEnum csvDelimiter)
void	setDownloadUrl(String downloadUrl)
void	setDurationFormat(ReportingExportJobResponse.DurationFormatEnum durationFormat)
void	setEmailErrorDescription(String emailErrorDescription)
void	setEmailStatuses(Map<String,ReportingExportJobResponse.InnerEnum> emailStatuses)
void	setEnabled(Boolean enabled)
void	setExcludeEmptyRows(Boolean excludeEmptyRows)
void	setExportAllowedToRerun(Boolean exportAllowedToRerun)
void	setExportErrorMessagesType(ReportingExportJobResponse.ExportErrorMessagesTypeEnum exportErrorMessagesType)
void	setExportFormat(ReportingExportJobResponse.ExportFormatEnum exportFormat)
void	setFilter(ViewFilter filter)
void	setHasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)
void	setHasFormatDurations(Boolean hasFormatDurations)
void	setHasSplitByMedia(Boolean hasSplitByMedia)
void	setHasSplitFilters(Boolean hasSplitFilters)
void	setHasSummaryRow(Boolean hasSummaryRow)
void	setIncludeDurationFormatInHeader(Boolean includeDurationFormatInHeader)
void	setInterval(String interval)
void	setLocale(String locale)
void	setModifiedDateTime(Date modifiedDateTime)
void	setName(String name)
void	setPercentageComplete(Double percentageComplete)
void	setPeriod(String period)
void	setRead(Boolean read)
void	setRecipientEmails(List<String> recipientEmails)
void	setRunId(String runId)
void	setSelectedColumns(List<SelectedColumns> selectedColumns)
void	setStatus(ReportingExportJobResponse.StatusEnum status)
void	setTimeZone(String timeZone)
void	setViewType(ReportingExportJobResponse.ViewTypeEnum viewType)
ReportingExportJobResponse	status(ReportingExportJobResponse.StatusEnum status)	The current status of the export request
ReportingExportJobResponse	timeZone(String timeZone)	The requested timezone of the exported data.
String	toString()
ReportingExportJobResponse	viewType(ReportingExportJobResponse.ViewTypeEnum viewType)	The type of view export job to be created

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ReportingExportJobResponse

public ReportingExportJobResponse()

ReportingExportJobResponse

public ReportingExportJobResponse(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public ReportingExportJobResponse name(String name)

getName

public String getName()

setName

public void setName(String name)

runId

public ReportingExportJobResponse runId(String runId)

The unique run id of the export schedule execute

getRunId

public String getRunId()

setRunId

public void setRunId(String runId)

status

public ReportingExportJobResponse status(ReportingExportJobResponse.StatusEnum status)

The current status of the export request

getStatus

public ReportingExportJobResponse.StatusEnum getStatus()

setStatus

public void setStatus(ReportingExportJobResponse.StatusEnum status)

timeZone

public ReportingExportJobResponse timeZone(String timeZone)

The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

exportFormat

public ReportingExportJobResponse exportFormat(ReportingExportJobResponse.ExportFormatEnum exportFormat)

The requested format of the exported data

getExportFormat

public ReportingExportJobResponse.ExportFormatEnum getExportFormat()

setExportFormat

public void setExportFormat(ReportingExportJobResponse.ExportFormatEnum exportFormat)

interval

public ReportingExportJobResponse interval(String interval)

The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

getInterval

public String getInterval()

setInterval

public void setInterval(String interval)

downloadUrl

public ReportingExportJobResponse downloadUrl(String downloadUrl)

The url to download the request if it's status is completed

getDownloadUrl

public String getDownloadUrl()

setDownloadUrl

public void setDownloadUrl(String downloadUrl)

viewType

public ReportingExportJobResponse viewType(ReportingExportJobResponse.ViewTypeEnum viewType)

The type of view export job to be created

getViewType

public ReportingExportJobResponse.ViewTypeEnum getViewType()

setViewType

public void setViewType(ReportingExportJobResponse.ViewTypeEnum viewType)

exportErrorMessagesType

public ReportingExportJobResponse exportErrorMessagesType(ReportingExportJobResponse.ExportErrorMessagesTypeEnum exportErrorMessagesType)

The error message in case the export request failed

getExportErrorMessagesType

public ReportingExportJobResponse.ExportErrorMessagesTypeEnum getExportErrorMessagesType()

setExportErrorMessagesType

public void setExportErrorMessagesType(ReportingExportJobResponse.ExportErrorMessagesTypeEnum exportErrorMessagesType)

period

public ReportingExportJobResponse period(String period)

The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H

getPeriod

public String getPeriod()

setPeriod

public void setPeriod(String period)

filter

public ReportingExportJobResponse filter(ViewFilter filter)

Filters to apply to create the view

getFilter

public ViewFilter getFilter()

setFilter

public void setFilter(ViewFilter filter)

read

public ReportingExportJobResponse read(Boolean read)

Indicates if the request has been marked as read

getRead

public Boolean getRead()

setRead

public void setRead(Boolean read)

createdDateTime

public ReportingExportJobResponse createdDateTime(Date createdDateTime)

The created date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getCreatedDateTime

public Date getCreatedDateTime()

setCreatedDateTime

public void setCreatedDateTime(Date createdDateTime)

modifiedDateTime

public ReportingExportJobResponse modifiedDateTime(Date modifiedDateTime)

The last modified date/time of the request. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getModifiedDateTime

public Date getModifiedDateTime()

setModifiedDateTime

public void setModifiedDateTime(Date modifiedDateTime)

locale

public ReportingExportJobResponse locale(String locale)

The locale use for localization of the exported data, i.e. en-us, es-mx

getLocale

public String getLocale()

setLocale

public void setLocale(String locale)

percentageComplete

public ReportingExportJobResponse percentageComplete(Double percentageComplete)

The percentage of the job that has completed processing

getPercentageComplete

public Double getPercentageComplete()

setPercentageComplete

public void setPercentageComplete(Double percentageComplete)

hasFormatDurations

public ReportingExportJobResponse hasFormatDurations(Boolean hasFormatDurations)

Indicates if durations are formatted in hh:mm:ss format instead of ms

getHasFormatDurations

public Boolean getHasFormatDurations()

setHasFormatDurations

public void setHasFormatDurations(Boolean hasFormatDurations)

hasSplitFilters

public ReportingExportJobResponse hasSplitFilters(Boolean hasSplitFilters)

Indicates if filters will be split in aggregate detail exports

getHasSplitFilters

public Boolean getHasSplitFilters()

setHasSplitFilters

public void setHasSplitFilters(Boolean hasSplitFilters)

excludeEmptyRows

public ReportingExportJobResponse excludeEmptyRows(Boolean excludeEmptyRows)

Excludes empty rows from the exports

getExcludeEmptyRows

public Boolean getExcludeEmptyRows()

setExcludeEmptyRows

public void setExcludeEmptyRows(Boolean excludeEmptyRows)

hasSplitByMedia

public ReportingExportJobResponse hasSplitByMedia(Boolean hasSplitByMedia)

Indicates if media type will be split in aggregate detail exports

getHasSplitByMedia

public Boolean getHasSplitByMedia()

setHasSplitByMedia

public void setHasSplitByMedia(Boolean hasSplitByMedia)

hasSummaryRow

public ReportingExportJobResponse hasSummaryRow(Boolean hasSummaryRow)

Indicates if summary row needs to be present in exports

getHasSummaryRow

public Boolean getHasSummaryRow()

setHasSummaryRow

public void setHasSummaryRow(Boolean hasSummaryRow)

csvDelimiter

public ReportingExportJobResponse csvDelimiter(ReportingExportJobResponse.CsvDelimiterEnum csvDelimiter)

The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request

getCsvDelimiter

public ReportingExportJobResponse.CsvDelimiterEnum getCsvDelimiter()

setCsvDelimiter

public void setCsvDelimiter(ReportingExportJobResponse.CsvDelimiterEnum csvDelimiter)

selectedColumns

public ReportingExportJobResponse selectedColumns(List<SelectedColumns> selectedColumns)

The list of ordered selected columns from the export view by the user

getSelectedColumns

public List<SelectedColumns> getSelectedColumns()

setSelectedColumns

public void setSelectedColumns(List<SelectedColumns> selectedColumns)

hasCustomParticipantAttributes

public ReportingExportJobResponse hasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)

Indicates if custom participant attributes will be exported

getHasCustomParticipantAttributes

public Boolean getHasCustomParticipantAttributes()

setHasCustomParticipantAttributes

public void setHasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)

recipientEmails

public ReportingExportJobResponse recipientEmails(List<String> recipientEmails)

The list of email recipients for the exports

getRecipientEmails

public List<String> getRecipientEmails()

setRecipientEmails

public void setRecipientEmails(List<String> recipientEmails)

emailStatuses

public ReportingExportJobResponse emailStatuses(Map<String,ReportingExportJobResponse.InnerEnum> emailStatuses)

The status of individual email addresses as a map

getEmailStatuses

public Map<String,ReportingExportJobResponse.InnerEnum> getEmailStatuses()

setEmailStatuses

public void setEmailStatuses(Map<String,ReportingExportJobResponse.InnerEnum> emailStatuses)

emailErrorDescription

public ReportingExportJobResponse emailErrorDescription(String emailErrorDescription)

The optional error message in case the export fail to email

getEmailErrorDescription

public String getEmailErrorDescription()

setEmailErrorDescription

public void setEmailErrorDescription(String emailErrorDescription)

includeDurationFormatInHeader

public ReportingExportJobResponse includeDurationFormatInHeader(Boolean includeDurationFormatInHeader)

Indicates whether to include selected duration format to the column headers

getIncludeDurationFormatInHeader

public Boolean getIncludeDurationFormatInHeader()

setIncludeDurationFormatInHeader

public void setIncludeDurationFormatInHeader(Boolean includeDurationFormatInHeader)

durationFormat

public ReportingExportJobResponse durationFormat(ReportingExportJobResponse.DurationFormatEnum durationFormat)

Indicates the duration format for the exports

getDurationFormat

public ReportingExportJobResponse.DurationFormatEnum getDurationFormat()

setDurationFormat

public void setDurationFormat(ReportingExportJobResponse.DurationFormatEnum durationFormat)

exportAllowedToRerun

public ReportingExportJobResponse exportAllowedToRerun(Boolean exportAllowedToRerun)

Indicates whether the export run is allowed to rerun

getExportAllowedToRerun

public Boolean getExportAllowedToRerun()

setExportAllowedToRerun

public void setExportAllowedToRerun(Boolean exportAllowedToRerun)

chartColumns

public ReportingExportJobResponse chartColumns(List<ChartColumn> chartColumns)

The list of columns for which chart is going to be displayed in export

getChartColumns

public List<ChartColumn> getChartColumns()

setChartColumns

public void setChartColumns(List<ChartColumn> chartColumns)

enabled

public ReportingExportJobResponse enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

setEnabled

public void setEnabled(Boolean enabled)

getSelfUri

public String getSelfUri()

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