Package com.mypurecloud.sdk.v2.model

Class RecordingJobsQuery

java.lang.Object
com.mypurecloud.sdk.v2.model.RecordingJobsQuery
All Implemented Interfaces:
Serializable
public class RecordingJobsQuery extends Object implements Serializable
RecordingJobsQuery
See Also:

  • Constructor Details

    • RecordingJobsQuery

      public RecordingJobsQuery()

    • RecordingJobsQuery

      public RecordingJobsQuery(Boolean initWithEmptyList)

  • Method Details

    • action

      public RecordingJobsQuery action(RecordingJobsQuery.ActionEnum action)
      Operation to perform bulk task. If the operation will cause the delete date of a recording to be older than the export date, the export date will be adjusted to the delete date.

    • getAction

      public RecordingJobsQuery.ActionEnum getAction()

    • setAction

      public void setAction(RecordingJobsQuery.ActionEnum action)

    • actionDate

      public RecordingJobsQuery actionDate(Date actionDate)
      The date when the action will be performed. If screenRecordingActionDate is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getActionDate

      public Date getActionDate()

    • setActionDate

      public void setActionDate(Date actionDate)

    • actionAge

      public RecordingJobsQuery actionAge(Integer actionAge)
      The number of days after each recording's creation date when the action will be performed. If screenRecordingActionAge is also provided, this value is only used for non-screen recordings. Otherwise this value is used for all recordings.

    • getActionAge

      public Integer getActionAge()

    • setActionAge

      public void setActionAge(Integer actionAge)

    • screenRecordingActionDate

      public RecordingJobsQuery screenRecordingActionDate(Date screenRecordingActionDate)
      The date when the action will be performed for screen recordings. If this is provided then includeScreenRecordings must be true. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getScreenRecordingActionDate

      public Date getScreenRecordingActionDate()

    • setScreenRecordingActionDate

      public void setScreenRecordingActionDate(Date screenRecordingActionDate)

    • screenRecordingActionAge

      public RecordingJobsQuery screenRecordingActionAge(Integer screenRecordingActionAge)
      The number of days after each screen recording's creation date when the action will be performed. If this is provided then includeScreenRecordings must be true.

    • getScreenRecordingActionAge

      public Integer getScreenRecordingActionAge()

    • setScreenRecordingActionAge

      public void setScreenRecordingActionAge(Integer screenRecordingActionAge)

    • integrationId

      public RecordingJobsQuery integrationId(String integrationId)
      IntegrationId to Access AWS S3 bucket for bulk recording exports. This field is required and used only for EXPORT action.

    • getIntegrationId

      public String getIntegrationId()

    • setIntegrationId

      public void setIntegrationId(String integrationId)

    • includeRecordingsWithSensitiveData

      public RecordingJobsQuery includeRecordingsWithSensitiveData(Boolean includeRecordingsWithSensitiveData)
      Whether to include recordings with PCI DSS and/or PII data, default value = false

    • getIncludeRecordingsWithSensitiveData

      public Boolean getIncludeRecordingsWithSensitiveData()

    • setIncludeRecordingsWithSensitiveData

      public void setIncludeRecordingsWithSensitiveData(Boolean includeRecordingsWithSensitiveData)

    • includeScreenRecordings

      public RecordingJobsQuery includeScreenRecordings(Boolean includeScreenRecordings)
      Whether to include Screen recordings for the action, default value = true

    • getIncludeScreenRecordings

      public Boolean getIncludeScreenRecordings()

    • setIncludeScreenRecordings

      public void setIncludeScreenRecordings(Boolean includeScreenRecordings)

    • includePolicyBasedRecordings

      public RecordingJobsQuery includePolicyBasedRecordings(Boolean includePolicyBasedRecordings)
      Whether to include policy-based recordings for the action, default value = true

    • getIncludePolicyBasedRecordings

      public Boolean getIncludePolicyBasedRecordings()

    • setIncludePolicyBasedRecordings

      public void setIncludePolicyBasedRecordings(Boolean includePolicyBasedRecordings)

    • includeSnippetRecordings

      public RecordingJobsQuery includeSnippetRecordings(Boolean includeSnippetRecordings)
      Whether to include snippet recordings for the action, default value = true

    • getIncludeSnippetRecordings

      public Boolean getIncludeSnippetRecordings()

    • setIncludeSnippetRecordings

      public void setIncludeSnippetRecordings(Boolean includeSnippetRecordings)

    • clearExport

      public RecordingJobsQuery clearExport(Boolean clearExport)
      For DELETE action, setting this to true will clear any pending exports for recordings. This field is only used for DELETE action. Default value = false

    • getClearExport

      public Boolean getClearExport()

    • setClearExport

      public void setClearExport(Boolean clearExport)

    • conversationQuery

      public RecordingJobsQuery conversationQuery(AsyncConversationQuery conversationQuery)
      Conversation Query. Note: After the recording is created, it might take up to 48 hours for the recording to be included in the submitted job query. This result depends on the analytics data lake job completion. See also: https://developer.genesys.cloud/analyticsdatamanagement/analytics/jobs/conversation-details-job#data-availability.

    • getConversationQuery

      public AsyncConversationQuery getConversationQuery()

    • setConversationQuery

      public void setConversationQuery(AsyncConversationQuery conversationQuery)

    • agedConversationInterval

      public RecordingJobsQuery agedConversationInterval(String agedConversationInterval)
      As an alternative to conversationQuery, specify the date and time range of conversations that are older than 5 years to query.Results will include all conversations that had activity during the interval. This is supported only when querying for conversations older than 5 years;conversationQuery must not be provided when this is provided. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss.Interval duration must not exceed 6 months. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

    • getAgedConversationInterval

      public String getAgedConversationInterval()

    • setAgedConversationInterval

      public void setAgedConversationInterval(String agedConversationInterval)

    • 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