com.amazonaws.services.transcribe.model.VocabularyInfo 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 information about a custom vocabulary, including the language of the custom vocabulary, when it was last
* modified, its name, and the processing state.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class VocabularyInfo implements Serializable, Cloneable, StructuredPojo {
/**
*
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and
* must be unique within an Amazon Web Services account.
*
*/
private String vocabularyName;
/**
*
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one
* language.
*
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For
* example, if you create a custom vocabulary using US English (en-US), you can only apply this custom
* vocabulary to files that contain English audio.
*
*/
private String languageCode;
/**
*
* The date and time the specified custom vocabulary was last modified.
*
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*
*/
private java.util.Date lastModifiedTime;
/**
*
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
*
*/
private String vocabularyState;
/**
*
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and
* must be unique within an Amazon Web Services account.
*
*
* @param vocabularyName
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain
* spaces, and must be unique within an Amazon Web Services account.
*/
public void setVocabularyName(String vocabularyName) {
this.vocabularyName = vocabularyName;
}
/**
*
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and
* must be unique within an Amazon Web Services account.
*
*
* @return A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain
* spaces, and must be unique within an Amazon Web Services account.
*/
public String getVocabularyName() {
return this.vocabularyName;
}
/**
*
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain spaces, and
* must be unique within an Amazon Web Services account.
*
*
* @param vocabularyName
* A unique name, chosen by you, for your custom vocabulary. This name is case sensitive, cannot contain
* spaces, 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 VocabularyInfo withVocabularyName(String vocabularyName) {
setVocabularyName(vocabularyName);
return this;
}
/**
*
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one
* language.
*
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For
* example, if you create a custom vocabulary using US English (en-US), you can only apply this custom
* vocabulary to files that contain English audio.
*
*
* @param languageCode
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only
* one language.
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary.
* For example, if you create a custom vocabulary using US English (en-US), you can only apply
* this custom vocabulary to files that contain English audio.
* @see LanguageCode
*/
public void setLanguageCode(String languageCode) {
this.languageCode = languageCode;
}
/**
*
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one
* language.
*
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For
* example, if you create a custom vocabulary using US English (en-US), you can only apply this custom
* vocabulary to files that contain English audio.
*
*
* @return The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in
* only one language.
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary.
* For example, if you create a custom vocabulary using US English (en-US), you can only apply
* this custom vocabulary to files that contain English audio.
* @see LanguageCode
*/
public String getLanguageCode() {
return this.languageCode;
}
/**
*
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one
* language.
*
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For
* example, if you create a custom vocabulary using US English (en-US), you can only apply this custom
* vocabulary to files that contain English audio.
*
*
* @param languageCode
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only
* one language.
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary.
* For example, if you create a custom vocabulary using US English (en-US), you can only apply
* this custom vocabulary to files that contain English audio.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public VocabularyInfo withLanguageCode(String languageCode) {
setLanguageCode(languageCode);
return this;
}
/**
*
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only one
* language.
*
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary. For
* example, if you create a custom vocabulary using US English (en-US), you can only apply this custom
* vocabulary to files that contain English audio.
*
*
* @param languageCode
* The language code used to create your custom vocabulary. Each custom vocabulary must contain terms in only
* one language.
*
* A custom vocabulary can only be used to transcribe files in the same language as the custom vocabulary.
* For example, if you create a custom vocabulary using US English (en-US), you can only apply
* this custom vocabulary to files that contain English audio.
* @return Returns a reference to this object so that method calls can be chained together.
* @see LanguageCode
*/
public VocabularyInfo withLanguageCode(LanguageCode languageCode) {
this.languageCode = languageCode.toString();
return this;
}
/**
*
* The date and time the specified custom vocabulary was last modified.
*
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*
*
* @param lastModifiedTime
* The date and time the specified custom vocabulary was last modified.
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*/
public void setLastModifiedTime(java.util.Date lastModifiedTime) {
this.lastModifiedTime = lastModifiedTime;
}
/**
*
* The date and time the specified custom vocabulary was last modified.
*
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*
*
* @return The date and time the specified custom vocabulary was last modified.
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*/
public java.util.Date getLastModifiedTime() {
return this.lastModifiedTime;
}
/**
*
* The date and time the specified custom vocabulary was last modified.
*
*
* 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 12:32 PM UTC-7 on May 4, 2022.
*
*
* @param lastModifiedTime
* The date and time the specified custom vocabulary was last modified.
*
* 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 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 VocabularyInfo withLastModifiedTime(java.util.Date lastModifiedTime) {
setLastModifiedTime(lastModifiedTime);
return this;
}
/**
*
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
*
*
* @param vocabularyState
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
* @see VocabularyState
*/
public void setVocabularyState(String vocabularyState) {
this.vocabularyState = vocabularyState;
}
/**
*
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
*
*
* @return The processing state of your custom vocabulary. If the state is READY, you can use the
* custom vocabulary in a StartTranscriptionJob request.
* @see VocabularyState
*/
public String getVocabularyState() {
return this.vocabularyState;
}
/**
*
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
*
*
* @param vocabularyState
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyState
*/
public VocabularyInfo withVocabularyState(String vocabularyState) {
setVocabularyState(vocabularyState);
return this;
}
/**
*
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
*
*
* @param vocabularyState
* The processing state of your custom vocabulary. If the state is READY, you can use the custom
* vocabulary in a StartTranscriptionJob request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VocabularyState
*/
public VocabularyInfo withVocabularyState(VocabularyState vocabularyState) {
this.vocabularyState = vocabularyState.toString();
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 (getVocabularyName() != null)
sb.append("VocabularyName: ").append(getVocabularyName()).append(",");
if (getLanguageCode() != null)
sb.append("LanguageCode: ").append(getLanguageCode()).append(",");
if (getLastModifiedTime() != null)
sb.append("LastModifiedTime: ").append(getLastModifiedTime()).append(",");
if (getVocabularyState() != null)
sb.append("VocabularyState: ").append(getVocabularyState());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof VocabularyInfo == false)
return false;
VocabularyInfo other = (VocabularyInfo) obj;
if (other.getVocabularyName() == null ^ this.getVocabularyName() == null)
return false;
if (other.getVocabularyName() != null && other.getVocabularyName().equals(this.getVocabularyName()) == 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.getLastModifiedTime() == null ^ this.getLastModifiedTime() == null)
return false;
if (other.getLastModifiedTime() != null && other.getLastModifiedTime().equals(this.getLastModifiedTime()) == false)
return false;
if (other.getVocabularyState() == null ^ this.getVocabularyState() == null)
return false;
if (other.getVocabularyState() != null && other.getVocabularyState().equals(this.getVocabularyState()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getVocabularyName() == null) ? 0 : getVocabularyName().hashCode());
hashCode = prime * hashCode + ((getLanguageCode() == null) ? 0 : getLanguageCode().hashCode());
hashCode = prime * hashCode + ((getLastModifiedTime() == null) ? 0 : getLastModifiedTime().hashCode());
hashCode = prime * hashCode + ((getVocabularyState() == null) ? 0 : getVocabularyState().hashCode());
return hashCode;
}
@Override
public VocabularyInfo clone() {
try {
return (VocabularyInfo) 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.VocabularyInfoMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}