Package com.mypurecloud.sdk.v2.model

Class RecordingMetadata

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

  • Constructor Details

    • RecordingMetadata

      public RecordingMetadata()

    • RecordingMetadata

      public RecordingMetadata(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public RecordingMetadata name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • conversationId

      public RecordingMetadata conversationId(String conversationId)

    • getConversationId

      public String getConversationId()

    • setConversationId

      public void setConversationId(String conversationId)

    • path

      public RecordingMetadata path(String path)

    • getPath

      public String getPath()

    • setPath

      public void setPath(String path)

    • startTime

      public RecordingMetadata startTime(String startTime)
      The start time of the recording for screen recordings. Null for other types.

    • getStartTime

      public String getStartTime()

    • setStartTime

      public void setStartTime(String startTime)

    • endTime

      public RecordingMetadata endTime(String endTime)

    • getEndTime

      public String getEndTime()

    • setEndTime

      public void setEndTime(String endTime)

    • media

      public RecordingMetadata media(String media)
      The type of media that the recording is. At the moment that could be audio, chat, email, or message.

    • getMedia

      public String getMedia()

    • setMedia

      public void setMedia(String media)

    • mediaSubtype

      public RecordingMetadata mediaSubtype(RecordingMetadata.MediaSubtypeEnum mediaSubtype)
      The recording media subtype.

    • getMediaSubtype

      public RecordingMetadata.MediaSubtypeEnum getMediaSubtype()

    • setMediaSubtype

      public void setMediaSubtype(RecordingMetadata.MediaSubtypeEnum mediaSubtype)

    • mediaSubject

      public RecordingMetadata mediaSubject(String mediaSubject)
      The recording media subject.

    • getMediaSubject

      public String getMediaSubject()

    • setMediaSubject

      public void setMediaSubject(String mediaSubject)

    • annotations

      public RecordingMetadata annotations(List<Annotation> annotations)
      Annotations that belong to the recording. Populated when recording filestate is AVAILABLE.

    • getAnnotations

      public List<Annotation> getAnnotations()

    • setAnnotations

      public void setAnnotations(List<Annotation> annotations)

    • fileState

      public RecordingMetadata fileState(RecordingMetadata.FileStateEnum fileState)
      Represents the current file state for a recording. Examples: Uploading, Archived, etc

    • getFileState

      public RecordingMetadata.FileStateEnum getFileState()

    • setFileState

      public void setFileState(RecordingMetadata.FileStateEnum fileState)

    • restoreExpirationTime

      public RecordingMetadata restoreExpirationTime(Date restoreExpirationTime)
      The amount of time a restored recording will remain restored before being archived again. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getRestoreExpirationTime

      public Date getRestoreExpirationTime()

    • setRestoreExpirationTime

      public void setRestoreExpirationTime(Date restoreExpirationTime)

    • archiveDate

      public RecordingMetadata archiveDate(Date archiveDate)
      The date the recording will be archived. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getArchiveDate

      public Date getArchiveDate()

    • setArchiveDate

      public void setArchiveDate(Date archiveDate)

    • archiveMedium

      public RecordingMetadata archiveMedium(RecordingMetadata.ArchiveMediumEnum archiveMedium)
      The type of archive medium used. Example: CloudArchive

    • getArchiveMedium

      public RecordingMetadata.ArchiveMediumEnum getArchiveMedium()

    • setArchiveMedium

      public void setArchiveMedium(RecordingMetadata.ArchiveMediumEnum archiveMedium)

    • deleteDate

      public RecordingMetadata deleteDate(Date deleteDate)
      The date the recording will be deleted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDeleteDate

      public Date getDeleteDate()

    • setDeleteDate

      public void setDeleteDate(Date deleteDate)

    • exportDate

      public RecordingMetadata exportDate(Date exportDate)
      The date the recording will be exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getExportDate

      public Date getExportDate()

    • setExportDate

      public void setExportDate(Date exportDate)

    • exportedDate

      public RecordingMetadata exportedDate(Date exportedDate)
      The date the recording was exported. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getExportedDate

      public Date getExportedDate()

    • setExportedDate

      public void setExportedDate(Date exportedDate)

    • maxAllowedRestorationsForOrg

      public RecordingMetadata maxAllowedRestorationsForOrg(Integer maxAllowedRestorationsForOrg)
      How many archive restorations the organization is allowed to have. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.

    • getMaxAllowedRestorationsForOrg

      public Integer getMaxAllowedRestorationsForOrg()

    • setMaxAllowedRestorationsForOrg

      public void setMaxAllowedRestorationsForOrg(Integer maxAllowedRestorationsForOrg)

    • remainingRestorationsAllowedForOrg

      public RecordingMetadata remainingRestorationsAllowedForOrg(Integer remainingRestorationsAllowedForOrg)
      The remaining archive restorations the organization has. Deprecated - Always returns 10000 since the restoration limit is no longer enforced.

    • getRemainingRestorationsAllowedForOrg

      public Integer getRemainingRestorationsAllowedForOrg()

    • setRemainingRestorationsAllowedForOrg

      public void setRemainingRestorationsAllowedForOrg(Integer remainingRestorationsAllowedForOrg)

    • sessionId

      public RecordingMetadata sessionId(String sessionId)
      The session id represents an external resource id, such as email, call, chat, etc

    • getSessionId

      public String getSessionId()

    • setSessionId

      public void setSessionId(String sessionId)

    • region

      public RecordingMetadata region(RecordingMetadata.RegionEnum region)
      The region the source recording is stored in

    • getRegion

      public RecordingMetadata.RegionEnum getRegion()

    • setRegion

      public void setRegion(RecordingMetadata.RegionEnum region)

    • 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