com.amazonaws.services.mediaconvert.model.Output Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* 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.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Each output in your job is a collection of settings that describes how you want MediaConvert to encode a single
* output file or stream. For more information, see
* https://docs.aws.amazon.com/mediaconvert/latest/ug/create-outputs.html.
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Output implements Serializable, Cloneable, StructuredPojo {
/**
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can
* contain multiple groups of encoding settings.
*/
private java.util.List audioDescriptions;
/**
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*/
private java.util.List captionDescriptions;
/** Container specific settings. */
private ContainerSettings containerSettings;
/**
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a value, the
* service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov
* * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec
* extensions (e.g. AAC, H265, H265, AC3)
*/
private String extension;
/**
* Use Name modifier to have the service add a string to the end of each output filename. You specify the base
* filename as part of your destination URI. When you create multiple outputs in the same output group, Name
* modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format
* identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output
* group.
*/
private String nameModifier;
/** Specific settings for this type of output. */
private OutputSettings outputSettings;
/**
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name. You can
* specify either Preset or Container settings, but not both.
*/
private String preset;
/**
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the video
* codec that you choose for the property codec. Include one instance of VideoDescription per output.
*/
private VideoDescription videoDescription;
/**
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can
* contain multiple groups of encoding settings.
*
* @return Contains groups of audio encoding settings organized by audio codec. Include one instance of per output.
* Can contain multiple groups of encoding settings.
*/
public java.util.List getAudioDescriptions() {
return audioDescriptions;
}
/**
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can
* contain multiple groups of encoding settings.
*
* @param audioDescriptions
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output.
* Can contain multiple groups of encoding settings.
*/
public void setAudioDescriptions(java.util.Collection audioDescriptions) {
if (audioDescriptions == null) {
this.audioDescriptions = null;
return;
}
this.audioDescriptions = new java.util.ArrayList(audioDescriptions);
}
/**
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can
* contain multiple groups of encoding settings.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAudioDescriptions(java.util.Collection)} or {@link #withAudioDescriptions(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param audioDescriptions
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output.
* Can contain multiple groups of encoding settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withAudioDescriptions(AudioDescription... audioDescriptions) {
if (this.audioDescriptions == null) {
setAudioDescriptions(new java.util.ArrayList(audioDescriptions.length));
}
for (AudioDescription ele : audioDescriptions) {
this.audioDescriptions.add(ele);
}
return this;
}
/**
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output. Can
* contain multiple groups of encoding settings.
*
* @param audioDescriptions
* Contains groups of audio encoding settings organized by audio codec. Include one instance of per output.
* Can contain multiple groups of encoding settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withAudioDescriptions(java.util.Collection audioDescriptions) {
setAudioDescriptions(audioDescriptions);
return this;
}
/**
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*
* @return Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*/
public java.util.List getCaptionDescriptions() {
return captionDescriptions;
}
/**
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*
* @param captionDescriptions
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*/
public void setCaptionDescriptions(java.util.Collection captionDescriptions) {
if (captionDescriptions == null) {
this.captionDescriptions = null;
return;
}
this.captionDescriptions = new java.util.ArrayList(captionDescriptions);
}
/**
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setCaptionDescriptions(java.util.Collection)} or {@link #withCaptionDescriptions(java.util.Collection)}
* if you want to override the existing values.
*
*
* @param captionDescriptions
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withCaptionDescriptions(CaptionDescription... captionDescriptions) {
if (this.captionDescriptions == null) {
setCaptionDescriptions(new java.util.ArrayList(captionDescriptions.length));
}
for (CaptionDescription ele : captionDescriptions) {
this.captionDescriptions.add(ele);
}
return this;
}
/**
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
*
* @param captionDescriptions
* Contains groups of captions settings. For each output that has captions, include one instance of
* CaptionDescriptions. Can contain multiple groups of captions settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withCaptionDescriptions(java.util.Collection captionDescriptions) {
setCaptionDescriptions(captionDescriptions);
return this;
}
/**
* Container specific settings.
*
* @param containerSettings
* Container specific settings.
*/
public void setContainerSettings(ContainerSettings containerSettings) {
this.containerSettings = containerSettings;
}
/**
* Container specific settings.
*
* @return Container specific settings.
*/
public ContainerSettings getContainerSettings() {
return this.containerSettings;
}
/**
* Container specific settings.
*
* @param containerSettings
* Container specific settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withContainerSettings(ContainerSettings containerSettings) {
setContainerSettings(containerSettings);
return this;
}
/**
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a value, the
* service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov
* * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec
* extensions (e.g. AAC, H265, H265, AC3)
*
* @param extension
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a
* value, the service will use default extensions by container type as follows * MPEG-2 transport stream,
* m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container,
* the service will use codec extensions (e.g. AAC, H265, H265, AC3)
*/
public void setExtension(String extension) {
this.extension = extension;
}
/**
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a value, the
* service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov
* * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec
* extensions (e.g. AAC, H265, H265, AC3)
*
* @return Use Extension to specify the file extension for outputs in File output groups. If you do not specify a
* value, the service will use default extensions by container type as follows * MPEG-2 transport stream,
* m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container,
* the service will use codec extensions (e.g. AAC, H265, H265, AC3)
*/
public String getExtension() {
return this.extension;
}
/**
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a value, the
* service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov
* * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec
* extensions (e.g. AAC, H265, H265, AC3)
*
* @param extension
* Use Extension to specify the file extension for outputs in File output groups. If you do not specify a
* value, the service will use default extensions by container type as follows * MPEG-2 transport stream,
* m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container,
* the service will use codec extensions (e.g. AAC, H265, H265, AC3)
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withExtension(String extension) {
setExtension(extension);
return this;
}
/**
* Use Name modifier to have the service add a string to the end of each output filename. You specify the base
* filename as part of your destination URI. When you create multiple outputs in the same output group, Name
* modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format
* identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output
* group.
*
* @param nameModifier
* Use Name modifier to have the service add a string to the end of each output filename. You specify the
* base filename as part of your destination URI. When you create multiple outputs in the same output group,
* Name modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use
* the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs
* of the output group.
*/
public void setNameModifier(String nameModifier) {
this.nameModifier = nameModifier;
}
/**
* Use Name modifier to have the service add a string to the end of each output filename. You specify the base
* filename as part of your destination URI. When you create multiple outputs in the same output group, Name
* modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format
* identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output
* group.
*
* @return Use Name modifier to have the service add a string to the end of each output filename. You specify the
* base filename as part of your destination URI. When you create multiple outputs in the same output group,
* Name modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you
* use the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all
* outputs of the output group.
*/
public String getNameModifier() {
return this.nameModifier;
}
/**
* Use Name modifier to have the service add a string to the end of each output filename. You specify the base
* filename as part of your destination URI. When you create multiple outputs in the same output group, Name
* modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use the format
* identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs of the output
* group.
*
* @param nameModifier
* Use Name modifier to have the service add a string to the end of each output filename. You specify the
* base filename as part of your destination URI. When you create multiple outputs in the same output group,
* Name modifier is required. Name modifier also accepts format identifiers. For DASH ISO outputs, if you use
* the format identifiers $Number$ or $Time$ in one output, you must use them in the same way in all outputs
* of the output group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withNameModifier(String nameModifier) {
setNameModifier(nameModifier);
return this;
}
/**
* Specific settings for this type of output.
*
* @param outputSettings
* Specific settings for this type of output.
*/
public void setOutputSettings(OutputSettings outputSettings) {
this.outputSettings = outputSettings;
}
/**
* Specific settings for this type of output.
*
* @return Specific settings for this type of output.
*/
public OutputSettings getOutputSettings() {
return this.outputSettings;
}
/**
* Specific settings for this type of output.
*
* @param outputSettings
* Specific settings for this type of output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withOutputSettings(OutputSettings outputSettings) {
setOutputSettings(outputSettings);
return this;
}
/**
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name. You can
* specify either Preset or Container settings, but not both.
*
* @param preset
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name.
* You can specify either Preset or Container settings, but not both.
*/
public void setPreset(String preset) {
this.preset = preset;
}
/**
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name. You can
* specify either Preset or Container settings, but not both.
*
* @return Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name.
* You can specify either Preset or Container settings, but not both.
*/
public String getPreset() {
return this.preset;
}
/**
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name. You can
* specify either Preset or Container settings, but not both.
*
* @param preset
* Use Preset to specify a preset for your transcoding settings. Provide the system or custom preset name.
* You can specify either Preset or Container settings, but not both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withPreset(String preset) {
setPreset(preset);
return this;
}
/**
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the video
* codec that you choose for the property codec. Include one instance of VideoDescription per output.
*
* @param videoDescription
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the
* video codec that you choose for the property codec. Include one instance of VideoDescription per output.
*/
public void setVideoDescription(VideoDescription videoDescription) {
this.videoDescription = videoDescription;
}
/**
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the video
* codec that you choose for the property codec. Include one instance of VideoDescription per output.
*
* @return VideoDescription contains a group of video encoding settings. The specific video settings depend on the
* video codec that you choose for the property codec. Include one instance of VideoDescription per output.
*/
public VideoDescription getVideoDescription() {
return this.videoDescription;
}
/**
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the video
* codec that you choose for the property codec. Include one instance of VideoDescription per output.
*
* @param videoDescription
* VideoDescription contains a group of video encoding settings. The specific video settings depend on the
* video codec that you choose for the property codec. Include one instance of VideoDescription per output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Output withVideoDescription(VideoDescription videoDescription) {
setVideoDescription(videoDescription);
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 (getAudioDescriptions() != null)
sb.append("AudioDescriptions: ").append(getAudioDescriptions()).append(",");
if (getCaptionDescriptions() != null)
sb.append("CaptionDescriptions: ").append(getCaptionDescriptions()).append(",");
if (getContainerSettings() != null)
sb.append("ContainerSettings: ").append(getContainerSettings()).append(",");
if (getExtension() != null)
sb.append("Extension: ").append(getExtension()).append(",");
if (getNameModifier() != null)
sb.append("NameModifier: ").append(getNameModifier()).append(",");
if (getOutputSettings() != null)
sb.append("OutputSettings: ").append(getOutputSettings()).append(",");
if (getPreset() != null)
sb.append("Preset: ").append(getPreset()).append(",");
if (getVideoDescription() != null)
sb.append("VideoDescription: ").append(getVideoDescription());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Output == false)
return false;
Output other = (Output) obj;
if (other.getAudioDescriptions() == null ^ this.getAudioDescriptions() == null)
return false;
if (other.getAudioDescriptions() != null && other.getAudioDescriptions().equals(this.getAudioDescriptions()) == false)
return false;
if (other.getCaptionDescriptions() == null ^ this.getCaptionDescriptions() == null)
return false;
if (other.getCaptionDescriptions() != null && other.getCaptionDescriptions().equals(this.getCaptionDescriptions()) == false)
return false;
if (other.getContainerSettings() == null ^ this.getContainerSettings() == null)
return false;
if (other.getContainerSettings() != null && other.getContainerSettings().equals(this.getContainerSettings()) == false)
return false;
if (other.getExtension() == null ^ this.getExtension() == null)
return false;
if (other.getExtension() != null && other.getExtension().equals(this.getExtension()) == false)
return false;
if (other.getNameModifier() == null ^ this.getNameModifier() == null)
return false;
if (other.getNameModifier() != null && other.getNameModifier().equals(this.getNameModifier()) == false)
return false;
if (other.getOutputSettings() == null ^ this.getOutputSettings() == null)
return false;
if (other.getOutputSettings() != null && other.getOutputSettings().equals(this.getOutputSettings()) == false)
return false;
if (other.getPreset() == null ^ this.getPreset() == null)
return false;
if (other.getPreset() != null && other.getPreset().equals(this.getPreset()) == false)
return false;
if (other.getVideoDescription() == null ^ this.getVideoDescription() == null)
return false;
if (other.getVideoDescription() != null && other.getVideoDescription().equals(this.getVideoDescription()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAudioDescriptions() == null) ? 0 : getAudioDescriptions().hashCode());
hashCode = prime * hashCode + ((getCaptionDescriptions() == null) ? 0 : getCaptionDescriptions().hashCode());
hashCode = prime * hashCode + ((getContainerSettings() == null) ? 0 : getContainerSettings().hashCode());
hashCode = prime * hashCode + ((getExtension() == null) ? 0 : getExtension().hashCode());
hashCode = prime * hashCode + ((getNameModifier() == null) ? 0 : getNameModifier().hashCode());
hashCode = prime * hashCode + ((getOutputSettings() == null) ? 0 : getOutputSettings().hashCode());
hashCode = prime * hashCode + ((getPreset() == null) ? 0 : getPreset().hashCode());
hashCode = prime * hashCode + ((getVideoDescription() == null) ? 0 : getVideoDescription().hashCode());
return hashCode;
}
@Override
public Output clone() {
try {
return (Output) 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.mediaconvert.model.transform.OutputMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}