software.amazon.awssdk.services.elastictranscoder.model.Captions Maven / Gradle / Ivy
Show all versions of elastictranscoder 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.elastictranscoder.model;
import java.beans.Transient;
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.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
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;
/**
*
* The captions to be created, if any.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class Captions implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField MERGE_POLICY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MergePolicy").getter(getter(Captions::mergePolicy)).setter(setter(Builder::mergePolicy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MergePolicy").build()).build();
private static final SdkField> CAPTION_SOURCES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CaptionSources")
.getter(getter(Captions::captionSources))
.setter(setter(Builder::captionSources))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CaptionSources").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CaptionSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> CAPTION_FORMATS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("CaptionFormats")
.getter(getter(Captions::captionFormats))
.setter(setter(Builder::captionFormats))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CaptionFormats").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CaptionFormat::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MERGE_POLICY_FIELD,
CAPTION_SOURCES_FIELD, CAPTION_FORMATS_FIELD));
private static final long serialVersionUID = 1L;
private final String mergePolicy;
private final List captionSources;
private final List captionFormats;
private Captions(BuilderImpl builder) {
this.mergePolicy = builder.mergePolicy;
this.captionSources = builder.captionSources;
this.captionFormats = builder.captionFormats;
}
/**
*
* A policy that determines how Elastic Transcoder handles the existence of multiple captions.
*
*
* -
*
* MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
* for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
* sidecar captions and ignores the embedded captions for that language.
*
*
* -
*
* MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If captions
* for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder uses the
* embedded captions and ignores the sidecar captions for that language. If CaptionSources is empty,
* Elastic Transcoder omits all sidecar captions from the output files.
*
*
* -
*
* Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
* CaptionSources.
*
*
*
*
* MergePolicy cannot be null.
*
*
* @return A policy that determines how Elastic Transcoder handles the existence of multiple captions.
*
* -
*
* MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If
* captions for a language are embedded in the input file and also appear in a sidecar file, Elastic
* Transcoder uses the sidecar captions and ignores the embedded captions for that language.
*
*
* -
*
* MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If
* captions for a language are embedded in the input file and also appear in a sidecar file, Elastic
* Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
* CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output
* files.
*
*
* -
*
* Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
* CaptionSources.
*
*
*
*
* MergePolicy cannot be null.
* @deprecated
*/
@Deprecated
public final String mergePolicy() {
return mergePolicy;
}
/**
* For responses, this returns true if the service returned a value for the CaptionSources 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.
*
* @deprecated
*/
@Deprecated
public final boolean hasCaptionSources() {
return captionSources != null && !(captionSources instanceof SdkAutoConstructList);
}
/**
*
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions,
* leave CaptionSources blank.
*
*
* 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 #hasCaptionSources} method.
*
*
* @return Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
* @deprecated
*/
@Deprecated
public final List captionSources() {
return captionSources;
}
/**
* For responses, this returns true if the service returned a value for the CaptionFormats 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 hasCaptionFormats() {
return captionFormats != null && !(captionFormats instanceof SdkAutoConstructList);
}
/**
*
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an
* error.
*
*
* 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 #hasCaptionFormats} method.
*
*
* @return The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder
* returns an error.
*/
public final List captionFormats() {
return captionFormats;
}
@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(mergePolicy());
hashCode = 31 * hashCode + Objects.hashCode(hasCaptionSources() ? captionSources() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasCaptionFormats() ? captionFormats() : null);
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 Captions)) {
return false;
}
Captions other = (Captions) obj;
return Objects.equals(mergePolicy(), other.mergePolicy()) && hasCaptionSources() == other.hasCaptionSources()
&& Objects.equals(captionSources(), other.captionSources()) && hasCaptionFormats() == other.hasCaptionFormats()
&& Objects.equals(captionFormats(), other.captionFormats());
}
/**
* 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("Captions").add("MergePolicy", mergePolicy())
.add("CaptionSources", hasCaptionSources() ? captionSources() : null)
.add("CaptionFormats", hasCaptionFormats() ? captionFormats() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "MergePolicy":
return Optional.ofNullable(clazz.cast(mergePolicy()));
case "CaptionSources":
return Optional.ofNullable(clazz.cast(captionSources()));
case "CaptionFormats":
return Optional.ofNullable(clazz.cast(captionFormats()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((Captions) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A policy that determines how Elastic Transcoder handles the existence of multiple captions.
*
*
* -
*
* MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If
* captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder
* uses the sidecar captions and ignores the embedded captions for that language.
*
*
* -
*
* MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If
* captions for a language are embedded in the input file and also appear in a sidecar file, Elastic Transcoder
* uses the embedded captions and ignores the sidecar captions for that language. If CaptionSources
* is empty, Elastic Transcoder omits all sidecar captions from the output files.
*
*
* -
*
* Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
* CaptionSources.
*
*
*
*
* MergePolicy cannot be null.
*
*
* @param mergePolicy
* A policy that determines how Elastic Transcoder handles the existence of multiple captions.
*
* -
*
* MergeOverride: Elastic Transcoder transcodes both embedded and sidecar captions into outputs.
* If captions for a language are embedded in the input file and also appear in a sidecar file, Elastic
* Transcoder uses the sidecar captions and ignores the embedded captions for that language.
*
*
* -
*
* MergeRetain: Elastic Transcoder transcodes both embedded and sidecar captions into outputs. If
* captions for a language are embedded in the input file and also appear in a sidecar file, Elastic
* Transcoder uses the embedded captions and ignores the sidecar captions for that language. If
* CaptionSources is empty, Elastic Transcoder omits all sidecar captions from the output
* files.
*
*
* -
*
* Override: Elastic Transcoder transcodes only the sidecar captions that you specify in
* CaptionSources.
*
*
*
*
* MergePolicy cannot be null.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated
*/
@Deprecated
Builder mergePolicy(String mergePolicy);
/**
*
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
*
*
* @param captionSources
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated
*/
@Deprecated
Builder captionSources(Collection captionSources);
/**
*
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
*
*
* @param captionSources
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated
*/
@Deprecated
Builder captionSources(CaptionSource... captionSources);
/**
*
* Source files for the input sidecar captions used during the transcoding process. To omit all sidecar
* captions, leave CaptionSources blank.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #captionSources(List)}.
*
* @param captionSources
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #captionSources(List)
* @deprecated
*/
@Deprecated
Builder captionSources(Consumer... captionSources);
/**
*
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns
* an error.
*
*
* @param captionFormats
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder
* returns an error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder captionFormats(Collection captionFormats);
/**
*
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns
* an error.
*
*
* @param captionFormats
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder
* returns an error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder captionFormats(CaptionFormat... captionFormats);
/**
*
* The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns
* an error.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding the need
* to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #captionFormats(List)}.
*
* @param captionFormats
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #captionFormats(List)
*/
Builder captionFormats(Consumer... captionFormats);
}
static final class BuilderImpl implements Builder {
private String mergePolicy;
private List captionSources = DefaultSdkAutoConstructList.getInstance();
private List captionFormats = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(Captions model) {
mergePolicy(model.mergePolicy);
captionSources(model.captionSources);
captionFormats(model.captionFormats);
}
@Deprecated
public final String getMergePolicy() {
return mergePolicy;
}
@Deprecated
public final void setMergePolicy(String mergePolicy) {
this.mergePolicy = mergePolicy;
}
@Override
@Transient
@Deprecated
public final Builder mergePolicy(String mergePolicy) {
this.mergePolicy = mergePolicy;
return this;
}
@Deprecated
public final List getCaptionSources() {
List result = CaptionSourcesCopier.copyToBuilder(this.captionSources);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
@Deprecated
public final void setCaptionSources(Collection captionSources) {
this.captionSources = CaptionSourcesCopier.copyFromBuilder(captionSources);
}
@Override
@Transient
@Deprecated
public final Builder captionSources(Collection captionSources) {
this.captionSources = CaptionSourcesCopier.copy(captionSources);
return this;
}
@Override
@Transient
@SafeVarargs
@Deprecated
public final Builder captionSources(CaptionSource... captionSources) {
captionSources(Arrays.asList(captionSources));
return this;
}
@Override
@Transient
@SafeVarargs
@Deprecated
public final Builder captionSources(Consumer... captionSources) {
captionSources(Stream.of(captionSources).map(c -> CaptionSource.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final List getCaptionFormats() {
List result = CaptionFormatsCopier.copyToBuilder(this.captionFormats);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setCaptionFormats(Collection captionFormats) {
this.captionFormats = CaptionFormatsCopier.copyFromBuilder(captionFormats);
}
@Override
@Transient
public final Builder captionFormats(Collection captionFormats) {
this.captionFormats = CaptionFormatsCopier.copy(captionFormats);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder captionFormats(CaptionFormat... captionFormats) {
captionFormats(Arrays.asList(captionFormats));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder captionFormats(Consumer... captionFormats) {
captionFormats(Stream.of(captionFormats).map(c -> CaptionFormat.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public Captions build() {
return new Captions(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}