software.amazon.awssdk.services.transcribe.model.SubtitlesOutput Maven / Gradle / Ivy
Show all versions of transcribe Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.transcribe.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides information about your subtitle file, including format, start index, and Amazon S3 location.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SubtitlesOutput implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> FORMATS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Formats")
.getter(getter(SubtitlesOutput::formatsAsStrings))
.setter(setter(Builder::formatsWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Formats").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SUBTITLE_FILE_URIS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SubtitleFileUris")
.getter(getter(SubtitlesOutput::subtitleFileUris))
.setter(setter(Builder::subtitleFileUris))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SubtitleFileUris").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField OUTPUT_START_INDEX_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("OutputStartIndex").getter(getter(SubtitlesOutput::outputStartIndex))
.setter(setter(Builder::outputStartIndex))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputStartIndex").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FORMATS_FIELD,
SUBTITLE_FILE_URIS_FIELD, OUTPUT_START_INDEX_FIELD));
private static final long serialVersionUID = 1L;
private final List formats;
private final List subtitleFileUris;
private final Integer outputStartIndex;
private SubtitlesOutput(BuilderImpl builder) {
this.formats = builder.formats;
this.subtitleFileUris = builder.subtitleFileUris;
this.outputStartIndex = builder.outputStartIndex;
}
/**
*
* Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (
* srt) formats, both formats are shown.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFormats} method.
*
*
* @return Provides the format of your subtitle files. If your request included both WebVTT (vtt) and
* SubRip (srt) formats, both formats are shown.
*/
public final List formats() {
return SubtitleFormatsCopier.copyStringToEnum(formats);
}
/**
* For responses, this returns true if the service returned a value for the Formats property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasFormats() {
return formats != null && !(formats instanceof SdkAutoConstructList);
}
/**
*
* Provides the format of your subtitle files. If your request included both WebVTT (vtt) and SubRip (
* srt) formats, both formats are shown.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasFormats} method.
*
*
* @return Provides the format of your subtitle files. If your request included both WebVTT (vtt) and
* SubRip (srt) formats, both formats are shown.
*/
public final List formatsAsStrings() {
return formats;
}
/**
* For responses, this returns true if the service returned a value for the SubtitleFileUris property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasSubtitleFileUris() {
return subtitleFileUris != null && !(subtitleFileUris instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasSubtitleFileUris} method.
*
*
* @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 final List subtitleFileUris() {
return 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.
*
*
* @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 final Integer outputStartIndex() {
return outputStartIndex;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(hasFormats() ? formatsAsStrings() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSubtitleFileUris() ? subtitleFileUris() : null);
hashCode = 31 * hashCode + Objects.hashCode(outputStartIndex());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SubtitlesOutput)) {
return false;
}
SubtitlesOutput other = (SubtitlesOutput) obj;
return hasFormats() == other.hasFormats() && Objects.equals(formatsAsStrings(), other.formatsAsStrings())
&& hasSubtitleFileUris() == other.hasSubtitleFileUris()
&& Objects.equals(subtitleFileUris(), other.subtitleFileUris())
&& Objects.equals(outputStartIndex(), other.outputStartIndex());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SubtitlesOutput").add("Formats", hasFormats() ? formatsAsStrings() : null)
.add("SubtitleFileUris", hasSubtitleFileUris() ? subtitleFileUris() : null)
.add("OutputStartIndex", outputStartIndex()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Formats":
return Optional.ofNullable(clazz.cast(formatsAsStrings()));
case "SubtitleFileUris":
return Optional.ofNullable(clazz.cast(subtitleFileUris()));
case "OutputStartIndex":
return Optional.ofNullable(clazz.cast(outputStartIndex()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SubtitlesOutput) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder formatsWithStrings(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder formatsWithStrings(String... 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder formats(Collection 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder formats(SubtitleFormat... 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.
*
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder subtitleFileUris(Collection 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder subtitleFileUris(String... 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.
*
*
* @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 Returns a reference to this object so that method calls can be chained together.
*/
Builder outputStartIndex(Integer outputStartIndex);
}
static final class BuilderImpl implements Builder {
private List formats = DefaultSdkAutoConstructList.getInstance();
private List subtitleFileUris = DefaultSdkAutoConstructList.getInstance();
private Integer outputStartIndex;
private BuilderImpl() {
}
private BuilderImpl(SubtitlesOutput model) {
formatsWithStrings(model.formats);
subtitleFileUris(model.subtitleFileUris);
outputStartIndex(model.outputStartIndex);
}
public final Collection getFormats() {
if (formats instanceof SdkAutoConstructList) {
return null;
}
return formats;
}
public final void setFormats(Collection formats) {
this.formats = SubtitleFormatsCopier.copy(formats);
}
@Override
public final Builder formatsWithStrings(Collection formats) {
this.formats = SubtitleFormatsCopier.copy(formats);
return this;
}
@Override
@SafeVarargs
public final Builder formatsWithStrings(String... formats) {
formatsWithStrings(Arrays.asList(formats));
return this;
}
@Override
public final Builder formats(Collection formats) {
this.formats = SubtitleFormatsCopier.copyEnumToString(formats);
return this;
}
@Override
@SafeVarargs
public final Builder formats(SubtitleFormat... formats) {
formats(Arrays.asList(formats));
return this;
}
public final Collection getSubtitleFileUris() {
if (subtitleFileUris instanceof SdkAutoConstructList) {
return null;
}
return subtitleFileUris;
}
public final void setSubtitleFileUris(Collection subtitleFileUris) {
this.subtitleFileUris = SubtitleFileUrisCopier.copy(subtitleFileUris);
}
@Override
public final Builder subtitleFileUris(Collection subtitleFileUris) {
this.subtitleFileUris = SubtitleFileUrisCopier.copy(subtitleFileUris);
return this;
}
@Override
@SafeVarargs
public final Builder subtitleFileUris(String... subtitleFileUris) {
subtitleFileUris(Arrays.asList(subtitleFileUris));
return this;
}
public final Integer getOutputStartIndex() {
return outputStartIndex;
}
public final void setOutputStartIndex(Integer outputStartIndex) {
this.outputStartIndex = outputStartIndex;
}
@Override
public final Builder outputStartIndex(Integer outputStartIndex) {
this.outputStartIndex = outputStartIndex;
return this;
}
@Override
public SubtitlesOutput build() {
return new SubtitlesOutput(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}