Package com.mypurecloud.sdk.v2.model

Class ReportingExportJobRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.ReportingExportJobRequest

All Implemented Interfaces:

Serializable

public class ReportingExportJobRequest
extends Object
implements Serializable

ReportingExportJobRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ReportingExportJobRequest.CsvDelimiterEnum	The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
static enum	ReportingExportJobRequest.DurationFormatEnum	Indicates the duration format for the exports
static enum	ReportingExportJobRequest.ExportFormatEnum	The requested format of the exported data
static enum	ReportingExportJobRequest.ViewTypeEnum	The type of view export job to be created

Constructor Summary

Constructors

Constructor	Description
ReportingExportJobRequest()
ReportingExportJobRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
ReportingExportJobRequest	chartColumns(List<ChartColumn> chartColumns)	The list of columns for which chart is going to be displayed in export
ReportingExportJobRequest	csvDelimiter(ReportingExportJobRequest.CsvDelimiterEnum csvDelimiter)	The user supplied csv delimiter string value either of type 'comma' or 'semicolon' permitted for the export request
ReportingExportJobRequest	durationFormat(ReportingExportJobRequest.DurationFormatEnum durationFormat)	Indicates the duration format for the exports
boolean	equals(Object o)
ReportingExportJobRequest	excludeEmptyRows(Boolean excludeEmptyRows)	Excludes empty rows from the exports
ReportingExportJobRequest	exportFormat(ReportingExportJobRequest.ExportFormatEnum exportFormat)	The requested format of the exported data
ReportingExportJobRequest	filter(ViewFilter filter)	Filters to apply to create the view
List<ChartColumn>	getChartColumns()
ReportingExportJobRequest.CsvDelimiterEnum	getCsvDelimiter()
ReportingExportJobRequest.DurationFormatEnum	getDurationFormat()
Boolean	getExcludeEmptyRows()
ReportingExportJobRequest.ExportFormatEnum	getExportFormat()
ViewFilter	getFilter()
Boolean	getHasCustomParticipantAttributes()
Boolean	getHasFormatDurations()
Boolean	getHasSplitByMedia()
Boolean	getHasSplitFilters()
Boolean	getHasSummaryRow()
Boolean	getIncludeDurationFormatInHeader()
String	getInterval()
String	getLocale()
String	getName()
String	getPeriod()
Boolean	getRead()
List<String>	getRecipientEmails()
List<SelectedColumns>	getSelectedColumns()
String	getTimeZone()
ReportingExportJobRequest.ViewTypeEnum	getViewType()
ReportingExportJobRequest	hasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)	Indicates if custom participant attributes will be exported
ReportingExportJobRequest	hasFormatDurations(Boolean hasFormatDurations)	Indicates if durations are formatted in hh:mm:ss format instead of ms
int	hashCode()
ReportingExportJobRequest	hasSplitByMedia(Boolean hasSplitByMedia)	Indicates if media type will be split in aggregate detail exports
ReportingExportJobRequest	hasSplitFilters(Boolean hasSplitFilters)	Indicates if filters will be split in aggregate detail exports
ReportingExportJobRequest	hasSummaryRow(Boolean hasSummaryRow)	Indicates if summary row needs to be present in exports
ReportingExportJobRequest	includeDurationFormatInHeader(Boolean includeDurationFormatInHeader)	Indicates whether to include selected duration format to the column headers
ReportingExportJobRequest	interval(String interval)	The time period used to limit the the exported data.
ReportingExportJobRequest	locale(String locale)	The locale used for localization of the exported data, i.e. en-US, es
ReportingExportJobRequest	name(String name)	The user supplied name of the export request
ReportingExportJobRequest	period(String period)	The Period of the request in which to break down the intervals.
ReportingExportJobRequest	read(Boolean read)	Indicates if the request has been marked as read
ReportingExportJobRequest	recipientEmails(List<String> recipientEmails)	The list of email recipients for the exports
ReportingExportJobRequest	selectedColumns(List<SelectedColumns> selectedColumns)	The list of ordered selected columns from the export view by the user
void	setChartColumns(List<ChartColumn> chartColumns)
void	setCsvDelimiter(ReportingExportJobRequest.CsvDelimiterEnum csvDelimiter)
void	setDurationFormat(ReportingExportJobRequest.DurationFormatEnum durationFormat)
void	setExcludeEmptyRows(Boolean excludeEmptyRows)
void	setExportFormat(ReportingExportJobRequest.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	setName(String name)
void	setPeriod(String period)
void	setRead(Boolean read)
void	setRecipientEmails(List<String> recipientEmails)
void	setSelectedColumns(List<SelectedColumns> selectedColumns)
void	setTimeZone(String timeZone)
void	setViewType(ReportingExportJobRequest.ViewTypeEnum viewType)
ReportingExportJobRequest	timeZone(String timeZone)	The requested timezone of the exported data.
String	toString()
ReportingExportJobRequest	viewType(ReportingExportJobRequest.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

ReportingExportJobRequest

public ReportingExportJobRequest()

ReportingExportJobRequest

public ReportingExportJobRequest(Boolean initWithEmptyList)

Method Details

name

public ReportingExportJobRequest name(String name)

The user supplied name of the export request

getName

public String getName()

setName

public void setName(String name)

timeZone

public ReportingExportJobRequest 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 ReportingExportJobRequest exportFormat(ReportingExportJobRequest.ExportFormatEnum exportFormat)

The requested format of the exported data

getExportFormat

public ReportingExportJobRequest.ExportFormatEnum getExportFormat()

setExportFormat

public void setExportFormat(ReportingExportJobRequest.ExportFormatEnum exportFormat)

interval

public ReportingExportJobRequest 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)

period

public ReportingExportJobRequest 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)

viewType

public ReportingExportJobRequest viewType(ReportingExportJobRequest.ViewTypeEnum viewType)

The type of view export job to be created

getViewType

public ReportingExportJobRequest.ViewTypeEnum getViewType()

setViewType

public void setViewType(ReportingExportJobRequest.ViewTypeEnum viewType)

filter

public ReportingExportJobRequest filter(ViewFilter filter)

Filters to apply to create the view

getFilter

public ViewFilter getFilter()

setFilter

public void setFilter(ViewFilter filter)

read

public ReportingExportJobRequest read(Boolean read)

Indicates if the request has been marked as read

getRead

public Boolean getRead()

setRead

public void setRead(Boolean read)

locale

public ReportingExportJobRequest locale(String locale)

The locale used for localization of the exported data, i.e. en-US, es

getLocale

public String getLocale()

setLocale

public void setLocale(String locale)

hasFormatDurations

public ReportingExportJobRequest 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 ReportingExportJobRequest 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 ReportingExportJobRequest excludeEmptyRows(Boolean excludeEmptyRows)

Excludes empty rows from the exports

getExcludeEmptyRows

public Boolean getExcludeEmptyRows()

setExcludeEmptyRows

public void setExcludeEmptyRows(Boolean excludeEmptyRows)

hasSplitByMedia

public ReportingExportJobRequest 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 ReportingExportJobRequest 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 ReportingExportJobRequest csvDelimiter(ReportingExportJobRequest.CsvDelimiterEnum csvDelimiter)

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

getCsvDelimiter

public ReportingExportJobRequest.CsvDelimiterEnum getCsvDelimiter()

setCsvDelimiter

public void setCsvDelimiter(ReportingExportJobRequest.CsvDelimiterEnum csvDelimiter)

selectedColumns

public ReportingExportJobRequest 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 ReportingExportJobRequest hasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)

Indicates if custom participant attributes will be exported

getHasCustomParticipantAttributes

public Boolean getHasCustomParticipantAttributes()

setHasCustomParticipantAttributes

public void setHasCustomParticipantAttributes(Boolean hasCustomParticipantAttributes)

recipientEmails

public ReportingExportJobRequest recipientEmails(List<String> recipientEmails)

The list of email recipients for the exports

getRecipientEmails

public List<String> getRecipientEmails()

setRecipientEmails

public void setRecipientEmails(List<String> recipientEmails)

includeDurationFormatInHeader

public ReportingExportJobRequest 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 ReportingExportJobRequest durationFormat(ReportingExportJobRequest.DurationFormatEnum durationFormat)

Indicates the duration format for the exports

getDurationFormat

public ReportingExportJobRequest.DurationFormatEnum getDurationFormat()

setDurationFormat

public void setDurationFormat(ReportingExportJobRequest.DurationFormatEnum durationFormat)

chartColumns

public ReportingExportJobRequest 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)

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