Class RecordingInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RecordingInfo.Builder,
RecordingInfo>
Information about a voice recording, chat transcript, or screen recording.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic RecordingInfo.Builder
builder()
final String
If the recording/transcript was deleted, this is the reason entered for the deletion.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.final String
The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
location()
The location, in Amazon S3, for the recording/transcript.final MediaStreamType
Information about the media stream used during the conversation.final String
Information about the media stream used during the conversation.final ParticipantType
Information about the conversation participant, whether they are an agent or contact.final String
Information about the conversation participant, whether they are an agent or contact.static Class
<? extends RecordingInfo.Builder> final Instant
When the conversation of the last leg of the recording started in UTC time.final RecordingStatus
status()
The status of the recording/transcript.final String
The status of the recording/transcript.final Instant
When the conversation of the last leg of recording stopped in UTC time.final StorageType
Where the recording/transcript is stored.final String
Where the recording/transcript is stored.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
storageType
Where the recording/transcript is stored.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- Where the recording/transcript is stored.
- See Also:
-
storageTypeAsString
Where the recording/transcript is stored.
If the service returns an enum value that is not available in the current SDK version,
storageType
will returnStorageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageTypeAsString()
.- Returns:
- Where the recording/transcript is stored.
- See Also:
-
location
The location, in Amazon S3, for the recording/transcript.
- Returns:
- The location, in Amazon S3, for the recording/transcript.
-
mediaStreamType
Information about the media stream used during the conversation.
If the service returns an enum value that is not available in the current SDK version,
mediaStreamType
will returnMediaStreamType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaStreamTypeAsString()
.- Returns:
- Information about the media stream used during the conversation.
- See Also:
-
mediaStreamTypeAsString
Information about the media stream used during the conversation.
If the service returns an enum value that is not available in the current SDK version,
mediaStreamType
will returnMediaStreamType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommediaStreamTypeAsString()
.- Returns:
- Information about the media stream used during the conversation.
- See Also:
-
participantType
Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
-
All
-
Manager
-
Agent
-
Customer
-
Thirdparty
-
Supervisor
If the service returns an enum value that is not available in the current SDK version,
participantType
will returnParticipantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantTypeAsString()
.- Returns:
- Information about the conversation participant, whether they are an agent or contact. The participant
types are as follows:
-
All
-
Manager
-
Agent
-
Customer
-
Thirdparty
-
Supervisor
-
- See Also:
-
-
participantTypeAsString
Information about the conversation participant, whether they are an agent or contact. The participant types are as follows:
-
All
-
Manager
-
Agent
-
Customer
-
Thirdparty
-
Supervisor
If the service returns an enum value that is not available in the current SDK version,
participantType
will returnParticipantType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromparticipantTypeAsString()
.- Returns:
- Information about the conversation participant, whether they are an agent or contact. The participant
types are as follows:
-
All
-
Manager
-
Agent
-
Customer
-
Thirdparty
-
Supervisor
-
- See Also:
-
-
fragmentStartNumber
The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
- Returns:
- The number that identifies the Kinesis Video Streams fragment where the customer audio stream started.
-
fragmentStopNumber
The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
- Returns:
- The number that identifies the Kinesis Video Streams fragment where the customer audio stream stopped.
-
startTimestamp
When the conversation of the last leg of the recording started in UTC time.
- Returns:
- When the conversation of the last leg of the recording started in UTC time.
-
stopTimestamp
When the conversation of the last leg of recording stopped in UTC time.
- Returns:
- When the conversation of the last leg of recording stopped in UTC time.
-
status
The status of the recording/transcript.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRecordingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the recording/transcript.
- See Also:
-
statusAsString
The status of the recording/transcript.
If the service returns an enum value that is not available in the current SDK version,
status
will returnRecordingStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the recording/transcript.
- See Also:
-
deletionReason
If the recording/transcript was deleted, this is the reason entered for the deletion.
- Returns:
- If the recording/transcript was deleted, this is the reason entered for the deletion.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<RecordingInfo.Builder,
RecordingInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-