com.amazonaws.services.transcribe.model

Class ListTranscriptionJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.ListTranscriptionJobsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListTranscriptionJobsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListTranscriptionJobsRequest()

Method Summary

Modifier and Type	Method and Description
ListTranscriptionJobsRequest	clone()
boolean	equals(Object obj)
String	getJobNameContains() When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
Integer	getMaxResults() The maximum number of jobs to return in each page of results.
String	getNextToken() If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
String	getStatus() When specified, returns only transcription jobs with the specified status.
int	hashCode()
void	setJobNameContains(String jobNameContains) When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
void	setMaxResults(Integer maxResults) The maximum number of jobs to return in each page of results.
void	setNextToken(String nextToken) If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
void	setStatus(String status) When specified, returns only transcription jobs with the specified status.
String	toString() Returns a string representation of this object.
ListTranscriptionJobsRequest	withJobNameContains(String jobNameContains) When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
ListTranscriptionJobsRequest	withMaxResults(Integer maxResults) The maximum number of jobs to return in each page of results.
ListTranscriptionJobsRequest	withNextToken(String nextToken) If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
ListTranscriptionJobsRequest	withStatus(String status) When specified, returns only transcription jobs with the specified status.
ListTranscriptionJobsRequest	withStatus(TranscriptionJobStatus status) When specified, returns only transcription jobs with the specified status.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTranscriptionJobsRequest

public ListTranscriptionJobsRequest()

Method Detail

setStatus

public void setStatus(String status)

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Parameters:

status - When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

getStatus

public String getStatus()

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Returns:

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

See Also:

TranscriptionJobStatus

withStatus

public ListTranscriptionJobsRequest withStatus(String status)

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Parameters:

status - When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

withStatus

public ListTranscriptionJobsRequest withStatus(TranscriptionJobStatus status)

When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Parameters:

status - When specified, returns only transcription jobs with the specified status. Jobs are ordered by creation date, with the newest jobs returned first. If you don’t specify a status, Amazon Transcribe returns all transcription jobs ordered by creation date.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

setJobNameContains

public void setJobNameContains(String jobNameContains)

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Parameters:

jobNameContains - When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

getJobNameContains

public String getJobNameContains()

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Returns:

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

withJobNameContains

public ListTranscriptionJobsRequest withJobNameContains(String jobNameContains)

When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Parameters:

jobNameContains - When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

Parameters:

nextToken - If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

getNextToken

public String getNextToken()

If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

Returns:

If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

withNextToken

public ListTranscriptionJobsRequest withNextToken(String nextToken)

If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

Parameters:

nextToken - If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Parameters:

maxResults - The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

getMaxResults

public Integer getMaxResults()

The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Returns:

The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

withMaxResults

public ListTranscriptionJobsRequest withMaxResults(Integer maxResults)

The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Parameters:

maxResults - The maximum number of jobs to return in each page of results. If there are fewer results than the value you specify, only the actual results are returned. If you do not specify a value, the default of 5 is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListTranscriptionJobsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest