Package ai.rev.topicextraction.models

Class TopicExtractionJobOptions

java.lang.Object

ai.rev.topicextraction.models.TopicExtractionJobOptions

public class TopicExtractionJobOptions
extends Object

A TopicExtractionJobOptions object represents parameters that are submitted along a new job.

See Also:

https://docs.rev.ai/api/topic-extraction/reference/#operation/SubmitTopicExtractionJob

Constructor Summary

Constructors

Constructor	Description
TopicExtractionJobOptions()

Method Summary

Modifier and Type	Method	Description
String	getCallbackUrl()	Deprecated. Use notificationConfig and getNotificationConfig instead
Integer	getDeleteAfterSeconds()	Returns the value of deleteAfterSeconds.
RevAiTranscript	getJson()	Returns the json.
String	getMetadata()	Returns the metadata.
CustomerUrlData	getNotificationConfig()	Returns the notification config object.
String	getText()	Returns the text.
void	setCallbackUrl(String callbackUrl)	Deprecated. Use setNotificationConfig instead
void	setDeleteAfterSeconds(Integer deleteAfterSeconds)	Specifies the number of seconds to be waited until the job is auto-deleted after its completion.
void	setJson(RevAiTranscript json)	Specifies a RevAiTranscript from the async api that will have topic extraction run on it
void	setMetadata(String metadata)	Optional metadata that is provided during job submission limited to 512 characters.
void	setNotificationConfig(String callbackUrl)	Optional property to specify the callback url that Rev AI will POST to when job processing is complete
void	setNotificationConfig(String callbackUrl, Map<String,String> authHeaders)	Optional property to specify the callback url that Rev AI will POST to when job processing is complete
void	setText(String text)	Specifies plain text that will have topic extraction run on it

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopicExtractionJobOptions

public TopicExtractionJobOptions()

Method Detail

getText

public String getText()

Returns the text.

Returns:

the text.

setText

public void setText(String text)

Specifies plain text that will have topic extraction run on it

Parameters:

text - plain text to be topic extracted.

getJson

public RevAiTranscript getJson()

Returns the json.

Returns:

the json.

setJson

public void setJson(RevAiTranscript json)

Specifies a RevAiTranscript from the async api that will have topic extraction run on it

Parameters:

json - RevAiTranscript to be topic extracted.

getCallbackUrl

@Deprecated
public String getCallbackUrl()

Deprecated.

Use notificationConfig and getNotificationConfig instead

Returns the callback url.

Returns:

the callback url.

setCallbackUrl

@Deprecated
public void setCallbackUrl(String callbackUrl)

Deprecated.

Use setNotificationConfig instead

Specifies the callback url that Rev AI will POST to when job processing is complete. This property is optional.

Parameters:

callbackUrl - The url to POST to when job processing is complete.

getNotificationConfig

public CustomerUrlData getNotificationConfig()

Returns the notification config object.

Returns:

the notification config.

setNotificationConfig

public void setNotificationConfig(String callbackUrl,
                                  Map<String,String> authHeaders)

Optional property to specify the callback url that Rev AI will POST to when job processing is complete

Parameters:

callbackUrl - The url to POST to when job processing is complete.

authHeaders - Optional parameter to authenticate access to the callback url

setNotificationConfig

public void setNotificationConfig(String callbackUrl)

Optional property to specify the callback url that Rev AI will POST to when job processing is complete

Parameters:

callbackUrl - The url to POST to when job processing is complete.

getMetadata

public String getMetadata()

Returns the metadata.

Returns:

A String that contains the metadata.

setMetadata

public void setMetadata(String metadata)

Optional metadata that is provided during job submission limited to 512 characters.

Parameters:

metadata - A String to set as the metadata.

getDeleteAfterSeconds

public Integer getDeleteAfterSeconds()

Returns the value of deleteAfterSeconds.

Returns:

The deleteAfterSeconds value.

setDeleteAfterSeconds

public void setDeleteAfterSeconds(Integer deleteAfterSeconds)

Specifies the number of seconds to be waited until the job is auto-deleted after its completion.

Parameters:

deleteAfterSeconds - The number of seconds after job completion when job is auto-deleted.