com.amazonaws.services.transcribe.model.ListTranscriptionJobsResult Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.transcribe.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListTranscriptionJobsResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*/
private String status;
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To view
* the next set of results, copy the string associated with the NextToken parameter in your results
* output, then run your request again including NextToken with the value of the copied string. Repeat
* as needed to view all your results.
*
*/
private String nextToken;
/**
*
* Provides a summary of information about each result.
*
*/
private java.util.List transcriptionJobSummaries;
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* @param status
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @see TranscriptionJobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* @return Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @see TranscriptionJobStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* @param status
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
public ListTranscriptionJobsResult withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* @param status
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
public ListTranscriptionJobsResult withStatus(TranscriptionJobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To view
* the next set of results, copy the string associated with the NextToken parameter in your results
* output, then run your request again including NextToken with the value of the copied string. Repeat
* as needed to view all your results.
*
*
* @param nextToken
* If NextToken is present in your response, it indicates that not all results are displayed. To
* view the next set of results, copy the string associated with the NextToken parameter in your
* results output, then run your request again including NextToken with the value of the copied
* string. Repeat as needed to view all your results.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To view
* the next set of results, copy the string associated with the NextToken parameter in your results
* output, then run your request again including NextToken with the value of the copied string. Repeat
* as needed to view all your results.
*
*
* @return If NextToken is present in your response, it indicates that not all results are displayed.
* To view the next set of results, copy the string associated with the NextToken parameter in
* your results output, then run your request again including NextToken with the value of the
* copied string. Repeat as needed to view all your results.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To view
* the next set of results, copy the string associated with the NextToken parameter in your results
* output, then run your request again including NextToken with the value of the copied string. Repeat
* as needed to view all your results.
*
*
* @param nextToken
* If NextToken is present in your response, it indicates that not all results are displayed. To
* view the next set of results, copy the string associated with the NextToken parameter in your
* results output, then run your request again including NextToken with the value of the copied
* string. Repeat as needed to view all your results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTranscriptionJobsResult withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* Provides a summary of information about each result.
*
*
* @return Provides a summary of information about each result.
*/
public java.util.List getTranscriptionJobSummaries() {
return transcriptionJobSummaries;
}
/**
*
* Provides a summary of information about each result.
*
*
* @param transcriptionJobSummaries
* Provides a summary of information about each result.
*/
public void setTranscriptionJobSummaries(java.util.Collection transcriptionJobSummaries) {
if (transcriptionJobSummaries == null) {
this.transcriptionJobSummaries = null;
return;
}
this.transcriptionJobSummaries = new java.util.ArrayList(transcriptionJobSummaries);
}
/**
*
* Provides a summary of information about each result.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTranscriptionJobSummaries(java.util.Collection)} or
* {@link #withTranscriptionJobSummaries(java.util.Collection)} if you want to override the existing values.
*
*
* @param transcriptionJobSummaries
* Provides a summary of information about each result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTranscriptionJobsResult withTranscriptionJobSummaries(TranscriptionJobSummary... transcriptionJobSummaries) {
if (this.transcriptionJobSummaries == null) {
setTranscriptionJobSummaries(new java.util.ArrayList(transcriptionJobSummaries.length));
}
for (TranscriptionJobSummary ele : transcriptionJobSummaries) {
this.transcriptionJobSummaries.add(ele);
}
return this;
}
/**
*
* Provides a summary of information about each result.
*
*
* @param transcriptionJobSummaries
* Provides a summary of information about each result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListTranscriptionJobsResult withTranscriptionJobSummaries(java.util.Collection transcriptionJobSummaries) {
setTranscriptionJobSummaries(transcriptionJobSummaries);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getTranscriptionJobSummaries() != null)
sb.append("TranscriptionJobSummaries: ").append(getTranscriptionJobSummaries());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListTranscriptionJobsResult == false)
return false;
ListTranscriptionJobsResult other = (ListTranscriptionJobsResult) obj;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getTranscriptionJobSummaries() == null ^ this.getTranscriptionJobSummaries() == null)
return false;
if (other.getTranscriptionJobSummaries() != null && other.getTranscriptionJobSummaries().equals(this.getTranscriptionJobSummaries()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getTranscriptionJobSummaries() == null) ? 0 : getTranscriptionJobSummaries().hashCode());
return hashCode;
}
@Override
public ListTranscriptionJobsResult clone() {
try {
return (ListTranscriptionJobsResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}