software.amazon.awssdk.services.mediapackage.model.CmafPackage Maven / Gradle / Ivy
Show all versions of mediapackage 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.mediapackage.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.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;
/**
* A Common Media Application Format (CMAF) packaging configuration.
*/
@Generated("software.amazon.awssdk:codegen")
public final class CmafPackage implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ENCRYPTION_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Encryption").getter(getter(CmafPackage::encryption)).setter(setter(Builder::encryption))
.constructor(CmafEncryption::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("encryption").build()).build();
private static final SdkField> HLS_MANIFESTS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("HlsManifests")
.getter(getter(CmafPackage::hlsManifests))
.setter(setter(Builder::hlsManifests))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("hlsManifests").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(HlsManifest::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SEGMENT_DURATION_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("SegmentDurationSeconds").getter(getter(CmafPackage::segmentDurationSeconds))
.setter(setter(Builder::segmentDurationSeconds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("segmentDurationSeconds").build())
.build();
private static final SdkField SEGMENT_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SegmentPrefix").getter(getter(CmafPackage::segmentPrefix)).setter(setter(Builder::segmentPrefix))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("segmentPrefix").build()).build();
private static final SdkField STREAM_SELECTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("StreamSelection")
.getter(getter(CmafPackage::streamSelection)).setter(setter(Builder::streamSelection))
.constructor(StreamSelection::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("streamSelection").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ENCRYPTION_FIELD,
HLS_MANIFESTS_FIELD, SEGMENT_DURATION_SECONDS_FIELD, SEGMENT_PREFIX_FIELD, STREAM_SELECTION_FIELD));
private static final long serialVersionUID = 1L;
private final CmafEncryption encryption;
private final List hlsManifests;
private final Integer segmentDurationSeconds;
private final String segmentPrefix;
private final StreamSelection streamSelection;
private CmafPackage(BuilderImpl builder) {
this.encryption = builder.encryption;
this.hlsManifests = builder.hlsManifests;
this.segmentDurationSeconds = builder.segmentDurationSeconds;
this.segmentPrefix = builder.segmentPrefix;
this.streamSelection = builder.streamSelection;
}
/**
* Returns the value of the Encryption property for this object.
*
* @return The value of the Encryption property for this object.
*/
public final CmafEncryption encryption() {
return encryption;
}
/**
* For responses, this returns true if the service returned a value for the HlsManifests 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 hasHlsManifests() {
return hlsManifests != null && !(hlsManifests instanceof SdkAutoConstructList);
}
/**
* A list of HLS manifest configurations
*
* 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 #hasHlsManifests} method.
*
*
* @return A list of HLS manifest configurations
*/
public final List hlsManifests() {
return hlsManifests;
}
/**
* Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
* segment duration.
*
* @return Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the
* source segment duration.
*/
public final Integer segmentDurationSeconds() {
return segmentDurationSeconds;
}
/**
* An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the
* ChannelId.
*
* @return An optional custom string that is prepended to the name of each segment. If not specified, it defaults to
* the ChannelId.
*/
public final String segmentPrefix() {
return segmentPrefix;
}
/**
* Returns the value of the StreamSelection property for this object.
*
* @return The value of the StreamSelection property for this object.
*/
public final StreamSelection streamSelection() {
return streamSelection;
}
@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(encryption());
hashCode = 31 * hashCode + Objects.hashCode(hasHlsManifests() ? hlsManifests() : null);
hashCode = 31 * hashCode + Objects.hashCode(segmentDurationSeconds());
hashCode = 31 * hashCode + Objects.hashCode(segmentPrefix());
hashCode = 31 * hashCode + Objects.hashCode(streamSelection());
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 CmafPackage)) {
return false;
}
CmafPackage other = (CmafPackage) obj;
return Objects.equals(encryption(), other.encryption()) && hasHlsManifests() == other.hasHlsManifests()
&& Objects.equals(hlsManifests(), other.hlsManifests())
&& Objects.equals(segmentDurationSeconds(), other.segmentDurationSeconds())
&& Objects.equals(segmentPrefix(), other.segmentPrefix())
&& Objects.equals(streamSelection(), other.streamSelection());
}
/**
* 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("CmafPackage").add("Encryption", encryption())
.add("HlsManifests", hasHlsManifests() ? hlsManifests() : null)
.add("SegmentDurationSeconds", segmentDurationSeconds()).add("SegmentPrefix", segmentPrefix())
.add("StreamSelection", streamSelection()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Encryption":
return Optional.ofNullable(clazz.cast(encryption()));
case "HlsManifests":
return Optional.ofNullable(clazz.cast(hlsManifests()));
case "SegmentDurationSeconds":
return Optional.ofNullable(clazz.cast(segmentDurationSeconds()));
case "SegmentPrefix":
return Optional.ofNullable(clazz.cast(segmentPrefix()));
case "StreamSelection":
return Optional.ofNullable(clazz.cast(streamSelection()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CmafPackage) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Sets the value of the Encryption property for this object.
*
* @param encryption
* The new value for the Encryption property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder encryption(CmafEncryption encryption);
/**
* Sets the value of the Encryption property for this object.
*
* This is a convenience method that creates an instance of the {@link CmafEncryption.Builder} avoiding the need
* to create one manually via {@link CmafEncryption#builder()}.
*
*
* When the {@link Consumer} completes, {@link CmafEncryption.Builder#build()} is called immediately and its
* result is passed to {@link #encryption(CmafEncryption)}.
*
* @param encryption
* a consumer that will call methods on {@link CmafEncryption.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #encryption(CmafEncryption)
*/
default Builder encryption(Consumer encryption) {
return encryption(CmafEncryption.builder().applyMutation(encryption).build());
}
/**
* A list of HLS manifest configurations
*
* @param hlsManifests
* A list of HLS manifest configurations
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hlsManifests(Collection hlsManifests);
/**
* A list of HLS manifest configurations
*
* @param hlsManifests
* A list of HLS manifest configurations
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder hlsManifests(HlsManifest... hlsManifests);
/**
* A list of HLS manifest configurations This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.mediapackage.model.HlsManifest.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.mediapackage.model.HlsManifest#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.mediapackage.model.HlsManifest.Builder#build()} is called immediately
* and its result is passed to {@link #hlsManifests(List)}.
*
* @param hlsManifests
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.mediapackage.model.HlsManifest.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #hlsManifests(java.util.Collection)
*/
Builder hlsManifests(Consumer... hlsManifests);
/**
* Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the source
* segment duration.
*
* @param segmentDurationSeconds
* Duration (in seconds) of each segment. Actual segments will be rounded to the nearest multiple of the
* source segment duration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder segmentDurationSeconds(Integer segmentDurationSeconds);
/**
* An optional custom string that is prepended to the name of each segment. If not specified, it defaults to the
* ChannelId.
*
* @param segmentPrefix
* An optional custom string that is prepended to the name of each segment. If not specified, it defaults
* to the ChannelId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder segmentPrefix(String segmentPrefix);
/**
* Sets the value of the StreamSelection property for this object.
*
* @param streamSelection
* The new value for the StreamSelection property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamSelection(StreamSelection streamSelection);
/**
* Sets the value of the StreamSelection property for this object.
*
* This is a convenience method that creates an instance of the {@link StreamSelection.Builder} avoiding the
* need to create one manually via {@link StreamSelection#builder()}.
*
*
* When the {@link Consumer} completes, {@link StreamSelection.Builder#build()} is called immediately and its
* result is passed to {@link #streamSelection(StreamSelection)}.
*
* @param streamSelection
* a consumer that will call methods on {@link StreamSelection.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #streamSelection(StreamSelection)
*/
default Builder streamSelection(Consumer streamSelection) {
return streamSelection(StreamSelection.builder().applyMutation(streamSelection).build());
}
}
static final class BuilderImpl implements Builder {
private CmafEncryption encryption;
private List hlsManifests = DefaultSdkAutoConstructList.getInstance();
private Integer segmentDurationSeconds;
private String segmentPrefix;
private StreamSelection streamSelection;
private BuilderImpl() {
}
private BuilderImpl(CmafPackage model) {
encryption(model.encryption);
hlsManifests(model.hlsManifests);
segmentDurationSeconds(model.segmentDurationSeconds);
segmentPrefix(model.segmentPrefix);
streamSelection(model.streamSelection);
}
public final CmafEncryption.Builder getEncryption() {
return encryption != null ? encryption.toBuilder() : null;
}
public final void setEncryption(CmafEncryption.BuilderImpl encryption) {
this.encryption = encryption != null ? encryption.build() : null;
}
@Override
public final Builder encryption(CmafEncryption encryption) {
this.encryption = encryption;
return this;
}
public final List getHlsManifests() {
List result = ___listOfHlsManifestCopier.copyToBuilder(this.hlsManifests);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setHlsManifests(Collection hlsManifests) {
this.hlsManifests = ___listOfHlsManifestCopier.copyFromBuilder(hlsManifests);
}
@Override
public final Builder hlsManifests(Collection hlsManifests) {
this.hlsManifests = ___listOfHlsManifestCopier.copy(hlsManifests);
return this;
}
@Override
@SafeVarargs
public final Builder hlsManifests(HlsManifest... hlsManifests) {
hlsManifests(Arrays.asList(hlsManifests));
return this;
}
@Override
@SafeVarargs
public final Builder hlsManifests(Consumer... hlsManifests) {
hlsManifests(Stream.of(hlsManifests).map(c -> HlsManifest.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final Integer getSegmentDurationSeconds() {
return segmentDurationSeconds;
}
public final void setSegmentDurationSeconds(Integer segmentDurationSeconds) {
this.segmentDurationSeconds = segmentDurationSeconds;
}
@Override
public final Builder segmentDurationSeconds(Integer segmentDurationSeconds) {
this.segmentDurationSeconds = segmentDurationSeconds;
return this;
}
public final String getSegmentPrefix() {
return segmentPrefix;
}
public final void setSegmentPrefix(String segmentPrefix) {
this.segmentPrefix = segmentPrefix;
}
@Override
public final Builder segmentPrefix(String segmentPrefix) {
this.segmentPrefix = segmentPrefix;
return this;
}
public final StreamSelection.Builder getStreamSelection() {
return streamSelection != null ? streamSelection.toBuilder() : null;
}
public final void setStreamSelection(StreamSelection.BuilderImpl streamSelection) {
this.streamSelection = streamSelection != null ? streamSelection.build() : null;
}
@Override
public final Builder streamSelection(StreamSelection streamSelection) {
this.streamSelection = streamSelection;
return this;
}
@Override
public CmafPackage build() {
return new CmafPackage(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}