java.lang.Object
- org.openapitools.client.model.RecordingAvailableCallback

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-21T09:43:53.001100-05:00[America/New_York]")
public class RecordingAvailableCallback
extends Object

The Recording Available event is sent after a recording has been processed. It indicates that the recording is available for download.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class RecordingAvailableCallback.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_ACCOUNT_ID`
`static String`	`SERIALIZED_NAME_APPLICATION_ID`
`static String`	`SERIALIZED_NAME_CALL_ID`
`static String`	`SERIALIZED_NAME_CALL_URL`
`static String`	`SERIALIZED_NAME_CHANNELS`
`static String`	`SERIALIZED_NAME_DIRECTION`
`static String`	`SERIALIZED_NAME_DURATION`
`static String`	`SERIALIZED_NAME_END_TIME`
`static String`	`SERIALIZED_NAME_ENQUEUED_TIME`
`static String`	`SERIALIZED_NAME_EVENT_TIME`
`static String`	`SERIALIZED_NAME_EVENT_TYPE`
`static String`	`SERIALIZED_NAME_FILE_FORMAT`
`static String`	`SERIALIZED_NAME_FROM`
`static String`	`SERIALIZED_NAME_MEDIA_URL`
`static String`	`SERIALIZED_NAME_PARENT_CALL_ID`
`static String`	`SERIALIZED_NAME_RECORDING_ID`
`static String`	`SERIALIZED_NAME_START_TIME`
`static String`	`SERIALIZED_NAME_STATUS`
`static String`	`SERIALIZED_NAME_TAG`
`static String`	`SERIALIZED_NAME_TO`
`static String`	`SERIALIZED_NAME_TRANSFER_CALLER_ID`
`static String`	`SERIALIZED_NAME_TRANSFER_TO`

Constructor Summary

Constructors
Constructor Description

RecordingAvailableCallback()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RecordingAvailableCallback`	`accountId(String accountId)`
`RecordingAvailableCallback`	`applicationId(String applicationId)`
`RecordingAvailableCallback`	`callId(String callId)`
`RecordingAvailableCallback`	`callUrl(String callUrl)`
`RecordingAvailableCallback`	`channels(String channels)`
`RecordingAvailableCallback`	`direction(CallDirectionEnum direction)`
`RecordingAvailableCallback`	`duration(String duration)`
`RecordingAvailableCallback`	`endTime(OffsetDateTime endTime)`
`RecordingAvailableCallback`	`enqueuedTime(OffsetDateTime enqueuedTime)`
`boolean`	`equals(Object o)`
`RecordingAvailableCallback`	`eventTime(String eventTime)`
`RecordingAvailableCallback`	`eventType(String eventType)`
`RecordingAvailableCallback`	`fileFormat(FileFormatEnum fileFormat)`
`RecordingAvailableCallback`	`from(String from)`
`static RecordingAvailableCallback`	`fromJson(String jsonString)`	Create an instance of RecordingAvailableCallback given an JSON string
`String`	`getAccountId()`	The user account associated with the call.
`String`	`getApplicationId()`	The id of the application associated with the call.
`String`	`getCallId()`	The call id associated with the event.
`String`	`getCallUrl()`	The URL of the call associated with the event.
`String`	`getChannels()`	The current status of the process.
`CallDirectionEnum`	`getDirection()`	Get direction
`String`	`getDuration()`	The duration of the recording in ISO-8601 format
`OffsetDateTime`	`getEndTime()`	The time that the recording ended in ISO-8601 format
`OffsetDateTime`	`getEnqueuedTime()`	(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
`String`	`getEventTime()`	The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format.
`String`	`getEventType()`	The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
`FileFormatEnum`	`getFileFormat()`	Get fileFormat
`String`	`getFrom()`	The provided identifier of the caller: can be a phone number in E.164 format (e.g.
`URI`	`getMediaUrl()`	The URL that can be used to download the recording.
`String`	`getParentCallId()`	(optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>.
`String`	`getRecordingId()`	The unique ID of this recording
`OffsetDateTime`	`getStartTime()`	Time the call was started, in ISO 8601 format.
`String`	`getStatus()`	The current status of the process.
`String`	`getTag()`	(optional) The tag specified on call creation.
`String`	`getTo()`	The phone number that received the call, in E.164 format (e.g.
`String`	`getTransferCallerId()`	The phone number used as the from field of the B-leg call, in E.164 format (e.g.
`String`	`getTransferTo()`	The phone number used as the to field of the B-leg call, in E.164 format (e.g.
`int`	`hashCode()`
`RecordingAvailableCallback`	`mediaUrl(URI mediaUrl)`
`RecordingAvailableCallback`	`parentCallId(String parentCallId)`
`RecordingAvailableCallback`	`recordingId(String recordingId)`
`void`	`setAccountId(String accountId)`
`void`	`setApplicationId(String applicationId)`
`void`	`setCallId(String callId)`
`void`	`setCallUrl(String callUrl)`
`void`	`setChannels(String channels)`
`void`	`setDirection(CallDirectionEnum direction)`
`void`	`setDuration(String duration)`
`void`	`setEndTime(OffsetDateTime endTime)`
`void`	`setEnqueuedTime(OffsetDateTime enqueuedTime)`
`void`	`setEventTime(String eventTime)`
`void`	`setEventType(String eventType)`
`void`	`setFileFormat(FileFormatEnum fileFormat)`
`void`	`setFrom(String from)`
`void`	`setMediaUrl(URI mediaUrl)`
`void`	`setParentCallId(String parentCallId)`
`void`	`setRecordingId(String recordingId)`
`void`	`setStartTime(OffsetDateTime startTime)`
`void`	`setStatus(String status)`
`void`	`setTag(String tag)`
`void`	`setTo(String to)`
`void`	`setTransferCallerId(String transferCallerId)`
`void`	`setTransferTo(String transferTo)`
`RecordingAvailableCallback`	`startTime(OffsetDateTime startTime)`
`RecordingAvailableCallback`	`status(String status)`
`RecordingAvailableCallback`	`tag(String tag)`
`RecordingAvailableCallback`	`to(String to)`
`String`	`toJson()`	Convert an instance of RecordingAvailableCallback to an JSON string
`String`	`toString()`
`RecordingAvailableCallback`	`transferCallerId(String transferCallerId)`
`RecordingAvailableCallback`	`transferTo(String transferTo)`
`static void`	`validateJsonObject(com.google.gson.JsonObject jsonObj)`	Validates the JSON Object and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_EVENT_TYPE
```
public static final String SERIALIZED_NAME_EVENT_TYPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EVENT_TIME
```
public static final String SERIALIZED_NAME_EVENT_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ACCOUNT_ID
```
public static final String SERIALIZED_NAME_ACCOUNT_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_APPLICATION_ID
```
public static final String SERIALIZED_NAME_APPLICATION_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FROM
```
public static final String SERIALIZED_NAME_FROM
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TO
```
public static final String SERIALIZED_NAME_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DIRECTION
```
public static final String SERIALIZED_NAME_DIRECTION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CALL_ID
```
public static final String SERIALIZED_NAME_CALL_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CALL_URL
```
public static final String SERIALIZED_NAME_CALL_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_PARENT_CALL_ID
```
public static final String SERIALIZED_NAME_PARENT_CALL_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_RECORDING_ID
```
public static final String SERIALIZED_NAME_RECORDING_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_MEDIA_URL
```
public static final String SERIALIZED_NAME_MEDIA_URL
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_ENQUEUED_TIME
```
public static final String SERIALIZED_NAME_ENQUEUED_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_START_TIME
```
public static final String SERIALIZED_NAME_START_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_END_TIME
```
public static final String SERIALIZED_NAME_END_TIME
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_DURATION
```
public static final String SERIALIZED_NAME_DURATION
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_FILE_FORMAT
```
public static final String SERIALIZED_NAME_FILE_FORMAT
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CHANNELS
```
public static final String SERIALIZED_NAME_CHANNELS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TAG
```
public static final String SERIALIZED_NAME_TAG
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_STATUS
```
public static final String SERIALIZED_NAME_STATUS
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSFER_CALLER_ID
```
public static final String SERIALIZED_NAME_TRANSFER_CALLER_ID
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_TRANSFER_TO
```
public static final String SERIALIZED_NAME_TRANSFER_TO
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - RecordingAvailableCallback
```
public RecordingAvailableCallback()
```
- Method Detail
  - eventType
```
public RecordingAvailableCallback eventType(String eventType)
```
  - getEventType
```
@Nullable
public String getEventType()
```
    The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
    
    Returns:
    
    eventType
  - setEventType
```
public void setEventType(String eventType)
```
  - eventTime
```
public RecordingAvailableCallback eventTime(String eventTime)
```
  - getEventTime
```
@Nullable
public String getEventTime()
```
    The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.
    
    Returns:
    
    eventTime
  - setEventTime
```
public void setEventTime(String eventTime)
```
  - accountId
```
public RecordingAvailableCallback accountId(String accountId)
```
  - getAccountId
```
@Nullable
public String getAccountId()
```
    The user account associated with the call.
    
    Returns:
    
    accountId
  - setAccountId
```
public void setAccountId(String accountId)
```
  - applicationId
```
public RecordingAvailableCallback applicationId(String applicationId)
```
  - getApplicationId
```
@Nullable
public String getApplicationId()
```
    The id of the application associated with the call.
    
    Returns:
    
    applicationId
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
  - from
```
public RecordingAvailableCallback from(String from)
```
  - getFrom
```
@Nullable
public String getFrom()
```
    The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.
    
    Returns:
    
    from
  - setFrom
```
public void setFrom(String from)
```
  - to
```
public RecordingAvailableCallback to(String to)
```
  - getTo
```
@Nullable
public String getTo()
```
    The phone number that received the call, in E.164 format (e.g. +15555555555).
    
    Returns:
    
    to
  - setTo
```
public void setTo(String to)
```
  - direction
```
public RecordingAvailableCallback direction(CallDirectionEnum direction)
```
  - getDirection
```
@Nullable
public CallDirectionEnum getDirection()
```
    Get direction
    
    Returns:
    
    direction
  - setDirection
```
public void setDirection(CallDirectionEnum direction)
```
  - callId
```
public RecordingAvailableCallback callId(String callId)
```
  - getCallId
```
@Nullable
public String getCallId()
```
    The call id associated with the event.
    
    Returns:
    
    callId
  - setCallId
```
public void setCallId(String callId)
```
  - callUrl
```
public RecordingAvailableCallback callUrl(String callUrl)
```
  - getCallUrl
```
@Nullable
public String getCallUrl()
```
    The URL of the call associated with the event.
    
    Returns:
    
    callUrl
  - setCallUrl
```
public void setCallUrl(String callUrl)
```
  - parentCallId
```
public RecordingAvailableCallback parentCallId(String parentCallId)
```
  - getParentCallId
```
@Nullable
public String getParentCallId()
```
    (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present.
    
    Returns:
    
    parentCallId
  - setParentCallId
```
public void setParentCallId(String parentCallId)
```
  - recordingId
```
public RecordingAvailableCallback recordingId(String recordingId)
```
  - getRecordingId
```
@Nullable
public String getRecordingId()
```
    The unique ID of this recording
    
    Returns:
    
    recordingId
  - setRecordingId
```
public void setRecordingId(String recordingId)
```
  - mediaUrl
```
public RecordingAvailableCallback mediaUrl(URI mediaUrl)
```
  - getMediaUrl
```
@Nullable
public URI getMediaUrl()
```
    The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded.
    
    Returns:
    
    mediaUrl
  - setMediaUrl
```
public void setMediaUrl(URI mediaUrl)
```
  - enqueuedTime
```
public RecordingAvailableCallback enqueuedTime(OffsetDateTime enqueuedTime)
```
  - getEnqueuedTime
```
@Nullable
public OffsetDateTime getEnqueuedTime()
```
    (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
    
    Returns:
    
    enqueuedTime
  - setEnqueuedTime
```
public void setEnqueuedTime(OffsetDateTime enqueuedTime)
```
  - startTime
```
public RecordingAvailableCallback startTime(OffsetDateTime startTime)
```
  - getStartTime
```
@Nullable
public OffsetDateTime getStartTime()
```
    Time the call was started, in ISO 8601 format.
    
    Returns:
    
    startTime
  - setStartTime
```
public void setStartTime(OffsetDateTime startTime)
```
  - endTime
```
public RecordingAvailableCallback endTime(OffsetDateTime endTime)
```
  - getEndTime
```
@Nullable
public OffsetDateTime getEndTime()
```
    The time that the recording ended in ISO-8601 format
    
    Returns:
    
    endTime
  - setEndTime
```
public void setEndTime(OffsetDateTime endTime)
```
  - duration
```
public RecordingAvailableCallback duration(String duration)
```
  - getDuration
```
@Nullable
public String getDuration()
```
    The duration of the recording in ISO-8601 format
    
    Returns:
    
    duration
  - setDuration
```
public void setDuration(String duration)
```
  - fileFormat
```
public RecordingAvailableCallback fileFormat(FileFormatEnum fileFormat)
```
  - getFileFormat
```
@Nullable
public FileFormatEnum getFileFormat()
```
    Get fileFormat
    
    Returns:
    
    fileFormat
  - setFileFormat
```
public void setFileFormat(FileFormatEnum fileFormat)
```
  - channels
```
public RecordingAvailableCallback channels(String channels)
```
  - getChannels
```
@Nullable
public String getChannels()
```
    The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.
    
    Returns:
    
    channels
  - setChannels
```
public void setChannels(String channels)
```
  - tag
```
public RecordingAvailableCallback tag(String tag)
```
  - getTag
```
@Nullable
public String getTag()
```
    (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.
    
    Returns:
    
    tag
  - setTag
```
public void setTag(String tag)
```
  - status
```
public RecordingAvailableCallback status(String status)
```
  - getStatus
```
@Nullable
public String getStatus()
```
    The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(String status)
```
  - transferCallerId
```
public RecordingAvailableCallback transferCallerId(String transferCallerId)
```
  - getTransferCallerId
```
@Nullable
public String getTransferCallerId()
```
    The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable.
    
    Returns:
    
    transferCallerId
  - setTransferCallerId
```
public void setTransferCallerId(String transferCallerId)
```
  - transferTo
```
public RecordingAvailableCallback transferTo(String transferTo)
```
  - getTransferTo
```
@Nullable
public String getTransferTo()
```
    The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).
    
    Returns:
    
    transferTo
  - setTransferTo
```
public void setTransferTo(String transferTo)
```
  - 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
  - validateJsonObject
```
public static void validateJsonObject(com.google.gson.JsonObject jsonObj)
                               throws IOException
```
    Validates the JSON Object and throws an exception if issues found
    
    Parameters:
    
    jsonObj - JSON Object
    
    Throws:
    
    IOException - if the JSON Object is invalid with respect to RecordingAvailableCallback
  - fromJson
```
public static RecordingAvailableCallback fromJson(String jsonString)
                                           throws IOException
```
    Create an instance of RecordingAvailableCallback given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of RecordingAvailableCallback
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to RecordingAvailableCallback
  - toJson
```
public String toJson()
```
    Convert an instance of RecordingAvailableCallback to an JSON string
    
    Returns:
    
    JSON string

Class RecordingAvailableCallback

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_EVENT_TYPE

SERIALIZED_NAME_EVENT_TIME

SERIALIZED_NAME_ACCOUNT_ID

SERIALIZED_NAME_APPLICATION_ID

SERIALIZED_NAME_FROM

SERIALIZED_NAME_TO

SERIALIZED_NAME_DIRECTION

SERIALIZED_NAME_CALL_ID

SERIALIZED_NAME_CALL_URL

SERIALIZED_NAME_PARENT_CALL_ID

SERIALIZED_NAME_RECORDING_ID

SERIALIZED_NAME_MEDIA_URL

SERIALIZED_NAME_ENQUEUED_TIME

SERIALIZED_NAME_START_TIME

SERIALIZED_NAME_END_TIME

SERIALIZED_NAME_DURATION

SERIALIZED_NAME_FILE_FORMAT

SERIALIZED_NAME_CHANNELS

SERIALIZED_NAME_TAG

SERIALIZED_NAME_STATUS

SERIALIZED_NAME_TRANSFER_CALLER_ID

SERIALIZED_NAME_TRANSFER_TO

openapiFields

openapiRequiredFields

Constructor Detail

RecordingAvailableCallback

Method Detail

eventType

getEventType

setEventType

eventTime

getEventTime

setEventTime

accountId

getAccountId

setAccountId

applicationId

getApplicationId

setApplicationId

from

getFrom

setFrom

to

getTo

setTo

direction

getDirection

setDirection

callId

getCallId

setCallId

callUrl

getCallUrl

setCallUrl

parentCallId

getParentCallId

setParentCallId

recordingId

getRecordingId

setRecordingId

mediaUrl

getMediaUrl

setMediaUrl

enqueuedTime

getEnqueuedTime

setEnqueuedTime

startTime

getStartTime

setStartTime

endTime

getEndTime

setEndTime

duration