com.amazonaws.services.transcribe.model.MedicalScribeJobSummary Maven / Gradle / Ivy
Show all versions of aws-java-sdk-transcribe Show documentation
/*
* 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;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides detailed information about a specific Medical Scribe job.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MedicalScribeJobSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services
* account.
*
*/
private String medicalScribeJobName;
/**
*
* The date and time the specified Medical Scribe job request was made.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*/
private java.util.Date creationTime;
/**
*
* The date and time your Medical Scribe job began processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*/
private java.util.Date startTime;
/**
*
* The date and time the specified Medical Scribe job finished processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32
* PM UTC-7 on May 4, 2022.
*
*/
private java.util.Date completionTime;
/**
*
* The language code used to create your Medical Scribe job. US English (en-US) is the only supported
* language for Medical Scribe jobs.
*
*/
private String languageCode;
/**
*
* Provides the status of the specified Medical Scribe job.
*
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED, FailureReason
* provides details on why your Medical Scribe job failed.
*
*/
private String medicalScribeJobStatus;
/**
*
* If MedicalScribeJobStatus is FAILED, FailureReason contains information
* about why the transcription job failed. See also: Common Errors.
*
*/
private String failureReason;
/**
*
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services
* account.
*
*
* @param medicalScribeJobName
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web
* Services account.
*/
public void setMedicalScribeJobName(String medicalScribeJobName) {
this.medicalScribeJobName = medicalScribeJobName;
}
/**
*
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services
* account.
*
*
* @return The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web
* Services account.
*/
public String getMedicalScribeJobName() {
return this.medicalScribeJobName;
}
/**
*
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web Services
* account.
*
*
* @param medicalScribeJobName
* The name of the Medical Scribe job. Job names are case sensitive and must be unique within an Amazon Web
* Services account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeJobSummary withMedicalScribeJobName(String medicalScribeJobName) {
setMedicalScribeJobName(medicalScribeJobName);
return this;
}
/**
*
* The date and time the specified Medical Scribe job request was made.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @param creationTime
* The date and time the specified Medical Scribe job request was made.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public void setCreationTime(java.util.Date creationTime) {
this.creationTime = creationTime;
}
/**
*
* The date and time the specified Medical Scribe job request was made.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @return The date and time the specified Medical Scribe job request was made.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getCreationTime() {
return this.creationTime;
}
/**
*
* The date and time the specified Medical Scribe job request was made.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @param creationTime
* The date and time the specified Medical Scribe job request was made.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeJobSummary withCreationTime(java.util.Date creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The date and time your Medical Scribe job began processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @param startTime
* The date and time your Medical Scribe job began processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The date and time your Medical Scribe job began processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @return The date and time your Medical Scribe job began processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The date and time your Medical Scribe job began processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at 12:32 PM
* UTC-7 on May 4, 2022.
*
*
* @param startTime
* The date and time your Medical Scribe job began processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.789000-07:00 represents a Medical Scribe job that started processing at
* 12:32 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeJobSummary withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The date and time the specified Medical Scribe job finished processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32
* PM UTC-7 on May 4, 2022.
*
*
* @param completionTime
* The date and time the specified Medical Scribe job finished processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public void setCompletionTime(java.util.Date completionTime) {
this.completionTime = completionTime;
}
/**
*
* The date and time the specified Medical Scribe job finished processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32
* PM UTC-7 on May 4, 2022.
*
*
* @return The date and time the specified Medical Scribe job finished processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at
* 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getCompletionTime() {
return this.completionTime;
}
/**
*
* The date and time the specified Medical Scribe job finished processing.
*
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at 12:32
* PM UTC-7 on May 4, 2022.
*
*
* @param completionTime
* The date and time the specified Medical Scribe job finished processing.
*
* Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example,
* 2022-05-04T12:32:58.761000-07:00 represents a Medical Scribe job that finished processing at
* 12:32 PM UTC-7 on May 4, 2022.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeJobSummary withCompletionTime(java.util.Date completionTime) {
setCompletionTime(completionTime);
return this;
}
/**
*
* The language code used to create your Medical Scribe job. US English (en-US) is the only supported
* language for Medical Scribe jobs.
*
*
* @param languageCode
* The language code used to create your Medical Scribe job. US English (en-US) is the only
* supported language for Medical Scribe jobs.
* @see MedicalScribeLanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The language code used to create your Medical Scribe job. US English (en-US) is the only supported
* language for Medical Scribe jobs.
*
*
* @return The language code used to create your Medical Scribe job. US English (en-US) is the only
* supported language for Medical Scribe jobs.
* @see MedicalScribeLanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The language code used to create your Medical Scribe job. US English (en-US) is the only supported
* language for Medical Scribe jobs.
*
*
* @param languageCode
* The language code used to create your Medical Scribe job. US English (en-US) is the only
* supported language for Medical Scribe jobs.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalScribeLanguageCode
*/
public MedicalScribeJobSummary withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* The language code used to create your Medical Scribe job. US English (en-US) is the only supported
* language for Medical Scribe jobs.
*
*
* @param languageCode
* The language code used to create your Medical Scribe job. US English (en-US) is the only
* supported language for Medical Scribe jobs.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalScribeLanguageCode
*/
public MedicalScribeJobSummary withLanguageCode(MedicalScribeLanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
*
* Provides the status of the specified Medical Scribe job.
*
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED, FailureReason
* provides details on why your Medical Scribe job failed.
*
*
* @param medicalScribeJobStatus
* Provides the status of the specified Medical Scribe job.
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED,
* FailureReason provides details on why your Medical Scribe job failed.
* @see MedicalScribeJobStatus
*/
public void setMedicalScribeJobStatus(String medicalScribeJobStatus) {
this.medicalScribeJobStatus = medicalScribeJobStatus;
}
/**
*
* Provides the status of the specified Medical Scribe job.
*
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED, FailureReason
* provides details on why your Medical Scribe job failed.
*
*
* @return Provides the status of the specified Medical Scribe job.
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED,
* FailureReason provides details on why your Medical Scribe job failed.
* @see MedicalScribeJobStatus
*/
public String getMedicalScribeJobStatus() {
return this.medicalScribeJobStatus;
}
/**
*
* Provides the status of the specified Medical Scribe job.
*
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED, FailureReason
* provides details on why your Medical Scribe job failed.
*
*
* @param medicalScribeJobStatus
* Provides the status of the specified Medical Scribe job.
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED,
* FailureReason provides details on why your Medical Scribe job failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalScribeJobStatus
*/
public MedicalScribeJobSummary withMedicalScribeJobStatus(String medicalScribeJobStatus) {
setMedicalScribeJobStatus(medicalScribeJobStatus);
return this;
}
/**
*
* Provides the status of the specified Medical Scribe job.
*
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED, FailureReason
* provides details on why your Medical Scribe job failed.
*
*
* @param medicalScribeJobStatus
* Provides the status of the specified Medical Scribe job.
*
* If the status is COMPLETED, the job is finished and you can find the results at the location
* specified in MedicalScribeOutput If the status is FAILED,
* FailureReason provides details on why your Medical Scribe job failed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MedicalScribeJobStatus
*/
public MedicalScribeJobSummary withMedicalScribeJobStatus(MedicalScribeJobStatus medicalScribeJobStatus) {
this.medicalScribeJobStatus = medicalScribeJobStatus.toString();
return this;
}
/**
*
* If MedicalScribeJobStatus is FAILED, FailureReason contains information
* about why the transcription job failed. See also: Common Errors.
*
*
* @param failureReason
* If MedicalScribeJobStatus is FAILED, FailureReason contains
* information about why the transcription job failed. See also: Common Errors.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If MedicalScribeJobStatus is FAILED, FailureReason contains information
* about why the transcription job failed. See also: Common Errors.
*
*
* @return If MedicalScribeJobStatus is FAILED, FailureReason contains
* information about why the transcription job failed. See also: Common Errors.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If MedicalScribeJobStatus is FAILED, FailureReason contains information
* about why the transcription job failed. See also: Common Errors.
*
*
* @param failureReason
* If MedicalScribeJobStatus is FAILED, FailureReason contains
* information about why the transcription job failed. See also: Common Errors.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MedicalScribeJobSummary withFailureReason(String failureReason) {
setFailureReason(failureReason);
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 (getMedicalScribeJobName() != null)
sb.append("MedicalScribeJobName: ").append(getMedicalScribeJobName()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getCompletionTime() != null)
sb.append("CompletionTime: ").append(getCompletionTime()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getMedicalScribeJobStatus() != null)
sb.append("MedicalScribeJobStatus: ").append(getMedicalScribeJobStatus()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MedicalScribeJobSummary == false)
return false;
MedicalScribeJobSummary other = (MedicalScribeJobSummary) obj;
if (other.getMedicalScribeJobName() == null ^ this.getMedicalScribeJobName() == null)
return false;
if (other.getMedicalScribeJobName() != null && other.getMedicalScribeJobName().equals(this.getMedicalScribeJobName()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getCompletionTime() == null ^ this.getCompletionTime() == null)
return false;
if (other.getCompletionTime() != null && other.getCompletionTime().equals(this.getCompletionTime()) == false)
return false;
if (other.getLanguageCode() == null ^ this.getLanguageCode() == null)
return false;
if (other.getLanguageCode() != null && other.getLanguageCode().equals(this.getLanguageCode()) == false)
return false;
if (other.getMedicalScribeJobStatus() == null ^ this.getMedicalScribeJobStatus() == null)
return false;
if (other.getMedicalScribeJobStatus() != null && other.getMedicalScribeJobStatus().equals(this.getMedicalScribeJobStatus()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getMedicalScribeJobName() == null) ? 0 : getMedicalScribeJobName().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getCompletionTime() == null) ? 0 : getCompletionTime().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getMedicalScribeJobStatus() == null) ? 0 : getMedicalScribeJobStatus().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
return hashCode;
}
@Override
public MedicalScribeJobSummary clone() {
try {
return (MedicalScribeJobSummary) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.transcribe.model.transform.MedicalScribeJobSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}