Package ai.rev.languageid.models

Class LanguageIdJobOptions

java.lang.Object

ai.rev.languageid.models.LanguageIdJobOptions

public class LanguageIdJobOptions
extends Object

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

See Also:

https://docs.rev.ai/api/language-identification/reference/#operation/SubmitLanguageIdentificationJob

Constructor Summary

Constructors

Constructor	Description
LanguageIdJobOptions()

Method Summary

Modifier and Type	Method	Description
String	getCallbackUrl()	Deprecated. Use notificationConfig and getNotificationConfig instead
Integer	getDeleteAfterSeconds()	Returns the value of deleteAfterSeconds.
String	getMediaUrl()	Deprecated. Set sourceConfig and use getSourceConfig instead
String	getMetadata()	Returns the metadata.
CustomerUrlData	getNotificationConfig()	Returns the notification config object.
CustomerUrlData	getSourceConfig()	Returns the source config object.
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	setMediaUrl(String mediaUrl)	Deprecated. Use setSourceConfig instead
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	setSourceConfig(String sourceMediaUrl)	Specifies the source media download url.
void	setSourceConfig(String sourceMediaUrl, Map<String,String> sourceAuth)	Specifies the url and any optional auth headers to access the source media download url.

Methods inherited from class java.lang.Object

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

Constructor Detail

LanguageIdJobOptions

public LanguageIdJobOptions()

Method Detail

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.

getMediaUrl

@Deprecated
public String getMediaUrl()

Deprecated.

Set sourceConfig and use getSourceConfig instead

Returns the media url.

Returns:

The media url.

setMediaUrl

@Deprecated
public void setMediaUrl(String mediaUrl)

Deprecated.

Use setSourceConfig instead

Specifies the url where the media can be downloaded.

Parameters:

mediaUrl - The direct download url to the file.

getSourceConfig

public CustomerUrlData getSourceConfig()

Returns the source config object.

Returns:

the source config.

setSourceConfig

public void setSourceConfig(String sourceMediaUrl,
                            Map<String,String> sourceAuth)

Specifies the url and any optional auth headers to access the source media download url.

Parameters:

sourceMediaUrl - The direct download url to the file.

sourceAuth - The auth headers to the source media download url.

setSourceConfig

public void setSourceConfig(String sourceMediaUrl)

Specifies the source media download url.

Parameters:

sourceMediaUrl - The direct download url to the file.