/* * Copyright 2010-2023 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; /** *

* Provides information about your subtitle file, including format, start index, * and Amazon S3 location. *

*/ public class SubtitlesOutput implements Serializable { /** *

* Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both * formats are shown. *

*/ private java.util.List formats; /** *

* The Amazon S3 location of your transcript. You can use this URI to access * or download your subtitle file. Your subtitle file is stored in the same * location as your transcript. If you specified both WebVTT and SubRip * subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your transcription job * request, this is the URI of that bucket. If you also included * OutputKey in your request, your output is located in the * path you specified in your request. *

*

* If you didn't include OutputBucketName in your transcription * job request, your subtitle file is stored in a service-managed bucket, * and TranscriptFileUri provides you with a temporary URI you * can use for secure access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only valid for * 15 minutes. If you get an AccesDenied error, you can get a * new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request. *

* */ private java.util.List subtitleFileUris; /** *

* Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used. *

*

* Constraints:
* Range: 0 - 1
*/ private Integer outputStartIndex; /** *

* Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both * formats are shown. *

* * @return

* Provides the format of your subtitle files. If your request * included both WebVTT (vtt) and SubRip ( * srt) formats, both formats are shown. *

*/ public java.util.List getFormats() { return formats; } /** *

* Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both * formats are shown. *

* * @param formats

* Provides the format of your subtitle files. If your request * included both WebVTT (vtt) and SubRip ( * srt) formats, both formats are shown. *

*/ public void setFormats(java.util.Collection formats) { if (formats == null) { this.formats = null; return; } this.formats = new java.util.ArrayList(formats); } /** *

* Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both * formats are shown. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param formats

* Provides the format of your subtitle files. If your request * included both WebVTT (vtt) and SubRip ( * srt) formats, both formats are shown. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SubtitlesOutput withFormats(String... formats) { if (getFormats() == null) { this.formats = new java.util.ArrayList(formats.length); } for (String value : formats) { this.formats.add(value); } return this; } /** *

* Provides the format of your subtitle files. If your request included both * WebVTT (vtt) and SubRip (srt) formats, both * formats are shown. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param formats

* Provides the format of your subtitle files. If your request * included both WebVTT (vtt) and SubRip ( * srt) formats, both formats are shown. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SubtitlesOutput withFormats(java.util.Collection formats) { setFormats(formats); return this; } /** *

* The Amazon S3 location of your transcript. You can use this URI to access * or download your subtitle file. Your subtitle file is stored in the same * location as your transcript. If you specified both WebVTT and SubRip * subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your transcription job * request, this is the URI of that bucket. If you also included * OutputKey in your request, your output is located in the * path you specified in your request. *

*

* If you didn't include OutputBucketName in your transcription * job request, your subtitle file is stored in a service-managed bucket, * and TranscriptFileUri provides you with a temporary URI you * can use for secure access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only valid for * 15 minutes. If you get an AccesDenied error, you can get a * new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request. *

* * * @return

* The Amazon S3 location of your transcript. You can use this URI * to access or download your subtitle file. Your subtitle file is * stored in the same location as your transcript. If you specified * both WebVTT and SubRip subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your * transcription job request, this is the URI of that bucket. If you * also included OutputKey in your request, your output * is located in the path you specified in your request. *

*

* If you didn't include OutputBucketName in your * transcription job request, your subtitle file is stored in a * service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure access * to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only * valid for 15 minutes. If you get an AccesDenied * error, you can get a new temporary URI by running a * GetTranscriptionJob or * ListTranscriptionJob request. *

* */ public java.util.List getSubtitleFileUris() { return subtitleFileUris; } /** *

* The Amazon S3 location of your transcript. You can use this URI to access * or download your subtitle file. Your subtitle file is stored in the same * location as your transcript. If you specified both WebVTT and SubRip * subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your transcription job * request, this is the URI of that bucket. If you also included * OutputKey in your request, your output is located in the * path you specified in your request. *

*

* If you didn't include OutputBucketName in your transcription * job request, your subtitle file is stored in a service-managed bucket, * and TranscriptFileUri provides you with a temporary URI you * can use for secure access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only valid for * 15 minutes. If you get an AccesDenied error, you can get a * new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request. *

* * * @param subtitleFileUris

* The Amazon S3 location of your transcript. You can use this * URI to access or download your subtitle file. Your subtitle * file is stored in the same location as your transcript. If you * specified both WebVTT and SubRip subtitle formats, two URIs * are provided. *

*

* If you included OutputBucketName in your * transcription job request, this is the URI of that bucket. If * you also included OutputKey in your request, your * output is located in the path you specified in your request. *

*

* If you didn't include OutputBucketName in your * transcription job request, your subtitle file is stored in a * service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure * access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only * valid for 15 minutes. If you get an AccesDenied * error, you can get a new temporary URI by running a * GetTranscriptionJob or * ListTranscriptionJob request. *

* */ public void setSubtitleFileUris(java.util.Collection subtitleFileUris) { if (subtitleFileUris == null) { this.subtitleFileUris = null; return; } this.subtitleFileUris = new java.util.ArrayList(subtitleFileUris); } /** *

* The Amazon S3 location of your transcript. You can use this URI to access * or download your subtitle file. Your subtitle file is stored in the same * location as your transcript. If you specified both WebVTT and SubRip * subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your transcription job * request, this is the URI of that bucket. If you also included * OutputKey in your request, your output is located in the * path you specified in your request. *

*

* If you didn't include OutputBucketName in your transcription * job request, your subtitle file is stored in a service-managed bucket, * and TranscriptFileUri provides you with a temporary URI you * can use for secure access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only valid for * 15 minutes. If you get an AccesDenied error, you can get a * new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request. *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param subtitleFileUris

* The Amazon S3 location of your transcript. You can use this * URI to access or download your subtitle file. Your subtitle * file is stored in the same location as your transcript. If you * specified both WebVTT and SubRip subtitle formats, two URIs * are provided. *

*

* If you included OutputBucketName in your * transcription job request, this is the URI of that bucket. If * you also included OutputKey in your request, your * output is located in the path you specified in your request. *

*

* If you didn't include OutputBucketName in your * transcription job request, your subtitle file is stored in a * service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure * access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only * valid for 15 minutes. If you get an AccesDenied * error, you can get a new temporary URI by running a * GetTranscriptionJob or * ListTranscriptionJob request. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SubtitlesOutput withSubtitleFileUris(String... subtitleFileUris) { if (getSubtitleFileUris() == null) { this.subtitleFileUris = new java.util.ArrayList(subtitleFileUris.length); } for (String value : subtitleFileUris) { this.subtitleFileUris.add(value); } return this; } /** *

* The Amazon S3 location of your transcript. You can use this URI to access * or download your subtitle file. Your subtitle file is stored in the same * location as your transcript. If you specified both WebVTT and SubRip * subtitle formats, two URIs are provided. *

*

* If you included OutputBucketName in your transcription job * request, this is the URI of that bucket. If you also included * OutputKey in your request, your output is located in the * path you specified in your request. *

*

* If you didn't include OutputBucketName in your transcription * job request, your subtitle file is stored in a service-managed bucket, * and TranscriptFileUri provides you with a temporary URI you * can use for secure access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only valid for * 15 minutes. If you get an AccesDenied error, you can get a * new temporary URI by running a GetTranscriptionJob or * ListTranscriptionJob request. *

* *

* Returns a reference to this object so that method calls can be chained * together. * * @param subtitleFileUris

* The Amazon S3 location of your transcript. You can use this * URI to access or download your subtitle file. Your subtitle * file is stored in the same location as your transcript. If you * specified both WebVTT and SubRip subtitle formats, two URIs * are provided. *

*

* If you included OutputBucketName in your * transcription job request, this is the URI of that bucket. If * you also included OutputKey in your request, your * output is located in the path you specified in your request. *

*

* If you didn't include OutputBucketName in your * transcription job request, your subtitle file is stored in a * service-managed bucket, and TranscriptFileUri * provides you with a temporary URI you can use for secure * access to your subtitle file. *

* *

* Temporary URIs for service-managed Amazon S3 buckets are only * valid for 15 minutes. If you get an AccesDenied * error, you can get a new temporary URI by running a * GetTranscriptionJob or * ListTranscriptionJob request. *

* * @return A reference to this updated object so that method calls can be * chained together. */ public SubtitlesOutput withSubtitleFileUris(java.util.Collection subtitleFileUris) { setSubtitleFileUris(subtitleFileUris); return this; } /** *

* Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used. *

*

* Constraints:
* Range: 0 - 1
* * @return

* Provides the start index value for your subtitle files. If you * did not specify a value in your request, the default value of * 0 is used. *

*/ public Integer getOutputStartIndex() { return outputStartIndex; } /** *

* Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used. *

*

* Constraints:
* Range: 0 - 1
* * @param outputStartIndex

* Provides the start index value for your subtitle files. If you * did not specify a value in your request, the default value of * 0 is used. *

*/ public void setOutputStartIndex(Integer outputStartIndex) { this.outputStartIndex = outputStartIndex; } /** *

* Provides the start index value for your subtitle files. If you did not * specify a value in your request, the default value of 0 is * used. *

*

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

* Constraints:
* Range: 0 - 1
* * @param outputStartIndex

* Provides the start index value for your subtitle files. If you * did not specify a value in your request, the default value of * 0 is used. *

* @return A reference to this updated object so that method calls can be * chained together. */ public SubtitlesOutput withOutputStartIndex(Integer outputStartIndex) { this.outputStartIndex = outputStartIndex; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getFormats() != null) sb.append("Formats: " + getFormats() + ","); if (getSubtitleFileUris() != null) sb.append("SubtitleFileUris: " + getSubtitleFileUris() + ","); if (getOutputStartIndex() != null) sb.append("OutputStartIndex: " + getOutputStartIndex()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getFormats() == null) ? 0 : getFormats().hashCode()); hashCode = prime * hashCode + ((getSubtitleFileUris() == null) ? 0 : getSubtitleFileUris().hashCode()); hashCode = prime * hashCode + ((getOutputStartIndex() == null) ? 0 : getOutputStartIndex().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SubtitlesOutput == false) return false; SubtitlesOutput other = (SubtitlesOutput) obj; if (other.getFormats() == null ^ this.getFormats() == null) return false; if (other.getFormats() != null && other.getFormats().equals(this.getFormats()) == false) return false; if (other.getSubtitleFileUris() == null ^ this.getSubtitleFileUris() == null) return false; if (other.getSubtitleFileUris() != null && other.getSubtitleFileUris().equals(this.getSubtitleFileUris()) == false) return false; if (other.getOutputStartIndex() == null ^ this.getOutputStartIndex() == null) return false; if (other.getOutputStartIndex() != null && other.getOutputStartIndex().equals(this.getOutputStartIndex()) == false) return false; return true; } }