com.amazonaws.services.transcribe.model

Class ListTranscriptionJobsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transcribe.model.ListTranscriptionJobsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListTranscriptionJobsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Lists transcription jobs with the specified status.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListTranscriptionJobsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getJobNameContains() When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
java.lang.Integer	getMaxResults() The maximum number of jobs to return in the response.
java.lang.String	getNextToken() If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
java.lang.String	getStatus() When specified, returns only transcription jobs with the specified status.
int	hashCode()
void	setJobNameContains(java.lang.String jobNameContains) When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of jobs to return in the response.
void	setNextToken(java.lang.String nextToken) If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
void	setStatus(java.lang.String status) When specified, returns only transcription jobs with the specified status.
void	setStatus(TranscriptionJobStatus status) When specified, returns only transcription jobs with the specified status.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListTranscriptionJobsRequest	withJobNameContains(java.lang.String jobNameContains) When specified, the jobs returned in the list are limited to jobs whose name contains the specified string.
ListTranscriptionJobsRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of jobs to return in the response.
ListTranscriptionJobsRequest	withNextToken(java.lang.String nextToken) If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
ListTranscriptionJobsRequest	withStatus(java.lang.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

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListTranscriptionJobsRequest

public ListTranscriptionJobsRequest()

Method Detail

getStatus

public java.lang.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.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

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

setStatus

public void setStatus(java.lang.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.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

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

withStatus

public ListTranscriptionJobsRequest withStatus(java.lang.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.

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

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

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:

A reference to this updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

setStatus

public void setStatus(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.

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

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

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.

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

Constraints:
Allowed Values: QUEUED, IN_PROGRESS, FAILED, COMPLETED

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:

A reference to this updated object so that method calls can be chained together.

See Also:

TranscriptionJobStatus

getJobNameContains

public java.lang.String getJobNameContains()

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Returns:

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

setJobNameContains

public void setJobNameContains(java.lang.String jobNameContains)

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

jobNameContains -

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

withJobNameContains

public ListTranscriptionJobsRequest withJobNameContains(java.lang.String jobNameContains)

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

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

Constraints:
Length: 1 - 200
Pattern: ^[0-9a-zA-Z._-]+

Parameters:

jobNameContains -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

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

Constraints:
Length: - 8192
Pattern: .+

Returns:

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

setNextToken

public void setNextToken(java.lang.String nextToken)

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

Constraints:
Length: - 8192
Pattern: .+

Parameters:

nextToken -

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

withNextToken

public ListTranscriptionJobsRequest withNextToken(java.lang.String nextToken)

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

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

Constraints:
Length: - 8192
Pattern: .+

Parameters:

nextToken -

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Integer getMaxResults()

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Constraints:
Range: 1 - 100

Returns:

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

setMaxResults

public void setMaxResults(java.lang.Integer maxResults)

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Constraints:
Range: 1 - 100

Parameters:

maxResults -

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

withMaxResults

public ListTranscriptionJobsRequest withMaxResults(java.lang.Integer maxResults)

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

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

Constraints:
Range: 1 - 100

Parameters:

maxResults -

The maximum number of jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object