software.amazon.awssdk.services.mediatailor.model.AdBreak Maven / Gradle / Ivy
/*
* 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.mediatailor.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;
/**
*
* Ad break configuration parameters.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AdBreak implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField> AD_BREAK_METADATA_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AdBreakMetadata")
.getter(getter(AdBreak::adBreakMetadata))
.setter(setter(Builder::adBreakMetadata))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdBreakMetadata").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(KeyValuePair::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MESSAGE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageType").getter(getter(AdBreak::messageTypeAsString)).setter(setter(Builder::messageType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageType").build()).build();
private static final SdkField OFFSET_MILLIS_FIELD = SdkField. builder(MarshallingType.LONG)
.memberName("OffsetMillis").getter(getter(AdBreak::offsetMillis)).setter(setter(Builder::offsetMillis))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OffsetMillis").build()).build();
private static final SdkField SLATE_FIELD = SdkField. builder(MarshallingType.SDK_POJO)
.memberName("Slate").getter(getter(AdBreak::slate)).setter(setter(Builder::slate)).constructor(SlateSource::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Slate").build()).build();
private static final SdkField SPLICE_INSERT_MESSAGE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("SpliceInsertMessage")
.getter(getter(AdBreak::spliceInsertMessage)).setter(setter(Builder::spliceInsertMessage))
.constructor(SpliceInsertMessage::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SpliceInsertMessage").build())
.build();
private static final SdkField TIME_SIGNAL_MESSAGE_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TimeSignalMessage")
.getter(getter(AdBreak::timeSignalMessage)).setter(setter(Builder::timeSignalMessage))
.constructor(TimeSignalMessage::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TimeSignalMessage").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AD_BREAK_METADATA_FIELD,
MESSAGE_TYPE_FIELD, OFFSET_MILLIS_FIELD, SLATE_FIELD, SPLICE_INSERT_MESSAGE_FIELD, TIME_SIGNAL_MESSAGE_FIELD));
private static final long serialVersionUID = 1L;
private final List adBreakMetadata;
private final String messageType;
private final Long offsetMillis;
private final SlateSource slate;
private final SpliceInsertMessage spliceInsertMessage;
private final TimeSignalMessage timeSignalMessage;
private AdBreak(BuilderImpl builder) {
this.adBreakMetadata = builder.adBreakMetadata;
this.messageType = builder.messageType;
this.offsetMillis = builder.offsetMillis;
this.slate = builder.slate;
this.spliceInsertMessage = builder.spliceInsertMessage;
this.timeSignalMessage = builder.timeSignalMessage;
}
/**
* For responses, this returns true if the service returned a value for the AdBreakMetadata 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 hasAdBreakMetadata() {
return adBreakMetadata != null && !(adBreakMetadata instanceof SdkAutoConstructList);
}
/**
*
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for
* SCTE35_ENHANCED output.
*
*
* 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 #hasAdBreakMetadata} method.
*
*
* @return Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for
* SCTE35_ENHANCED output.
*/
public final List adBreakMetadata() {
return adBreakMetadata;
}
/**
*
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #messageType} will
* return {@link MessageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageTypeAsString}.
*
*
* @return The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
* @see MessageType
*/
public final MessageType messageType() {
return MessageType.fromValue(messageType);
}
/**
*
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #messageType} will
* return {@link MessageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageTypeAsString}.
*
*
* @return The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
* @see MessageType
*/
public final String messageTypeAsString() {
return messageType;
}
/**
*
* How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within
* 100ms of a segment boundary, otherwise the ad break will be skipped.
*
*
* @return How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall
* within 100ms of a segment boundary, otherwise the ad break will be skipped.
*/
public final Long offsetMillis() {
return offsetMillis;
}
/**
*
* Ad break slate configuration.
*
*
* @return Ad break slate configuration.
*/
public final SlateSource slate() {
return slate;
}
/**
*
* This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using
* splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
*
*
* @return This defines the SCTE-35 splice_insert() message inserted around the ad. For information
* about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
*/
public final SpliceInsertMessage spliceInsertMessage() {
return spliceInsertMessage;
}
/**
*
* Defines the SCTE-35 time_signal message inserted around the ad.
*
*
* Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a
* splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad
* break.
*
*
* See section 9.7.4 of the 2022 SCTE-35 specification for more information.
*
*
* @return Defines the SCTE-35 time_signal message inserted around the ad.
*
* Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a
* splice_insert SCTE-35 message to the ad break. This message provides basic metadata about
* the ad break.
*
*
* See section 9.7.4 of the 2022 SCTE-35 specification for more information.
*/
public final TimeSignalMessage timeSignalMessage() {
return timeSignalMessage;
}
@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(hasAdBreakMetadata() ? adBreakMetadata() : null);
hashCode = 31 * hashCode + Objects.hashCode(messageTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(offsetMillis());
hashCode = 31 * hashCode + Objects.hashCode(slate());
hashCode = 31 * hashCode + Objects.hashCode(spliceInsertMessage());
hashCode = 31 * hashCode + Objects.hashCode(timeSignalMessage());
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 AdBreak)) {
return false;
}
AdBreak other = (AdBreak) obj;
return hasAdBreakMetadata() == other.hasAdBreakMetadata() && Objects.equals(adBreakMetadata(), other.adBreakMetadata())
&& Objects.equals(messageTypeAsString(), other.messageTypeAsString())
&& Objects.equals(offsetMillis(), other.offsetMillis()) && Objects.equals(slate(), other.slate())
&& Objects.equals(spliceInsertMessage(), other.spliceInsertMessage())
&& Objects.equals(timeSignalMessage(), other.timeSignalMessage());
}
/**
* 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("AdBreak").add("AdBreakMetadata", hasAdBreakMetadata() ? adBreakMetadata() : null)
.add("MessageType", messageTypeAsString()).add("OffsetMillis", offsetMillis()).add("Slate", slate())
.add("SpliceInsertMessage", spliceInsertMessage()).add("TimeSignalMessage", timeSignalMessage()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AdBreakMetadata":
return Optional.ofNullable(clazz.cast(adBreakMetadata()));
case "MessageType":
return Optional.ofNullable(clazz.cast(messageTypeAsString()));
case "OffsetMillis":
return Optional.ofNullable(clazz.cast(offsetMillis()));
case "Slate":
return Optional.ofNullable(clazz.cast(slate()));
case "SpliceInsertMessage":
return Optional.ofNullable(clazz.cast(spliceInsertMessage()));
case "TimeSignalMessage":
return Optional.ofNullable(clazz.cast(timeSignalMessage()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AdBreak) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for
* SCTE35_ENHANCED output.
*
*
* @param adBreakMetadata
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag
* for SCTE35_ENHANCED output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder adBreakMetadata(Collection adBreakMetadata);
/**
*
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for
* SCTE35_ENHANCED output.
*
*
* @param adBreakMetadata
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag
* for SCTE35_ENHANCED output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder adBreakMetadata(KeyValuePair... adBreakMetadata);
/**
*
* Defines a list of key/value pairs that MediaTailor generates within the EXT-X-ASSETtag for
* SCTE35_ENHANCED output.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.mediatailor.model.KeyValuePair.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.mediatailor.model.KeyValuePair#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.mediatailor.model.KeyValuePair.Builder#build()} is called immediately
* and its result is passed to {@link #adBreakMetadata(List)}.
*
* @param adBreakMetadata
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.mediatailor.model.KeyValuePair.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #adBreakMetadata(java.util.Collection)
*/
Builder adBreakMetadata(Consumer... adBreakMetadata);
/**
*
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
*
*
* @param messageType
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
* @see MessageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
Builder messageType(String messageType);
/**
*
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
*
*
* @param messageType
* The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT, TIME_SIGNAL.
* @see MessageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
Builder messageType(MessageType messageType);
/**
*
* How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within
* 100ms of a segment boundary, otherwise the ad break will be skipped.
*
*
* @param offsetMillis
* How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall
* within 100ms of a segment boundary, otherwise the ad break will be skipped.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder offsetMillis(Long offsetMillis);
/**
*
* Ad break slate configuration.
*
*
* @param slate
* Ad break slate configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder slate(SlateSource slate);
/**
*
* Ad break slate configuration.
*
* This is a convenience method that creates an instance of the {@link SlateSource.Builder} avoiding the need to
* create one manually via {@link SlateSource#builder()}.
*
*
* When the {@link Consumer} completes, {@link SlateSource.Builder#build()} is called immediately and its result
* is passed to {@link #slate(SlateSource)}.
*
* @param slate
* a consumer that will call methods on {@link SlateSource.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #slate(SlateSource)
*/
default Builder slate(Consumer slate) {
return slate(SlateSource.builder().applyMutation(slate).build());
}
/**
*
* This defines the SCTE-35 splice_insert() message inserted around the ad. For information about
* using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
*
*
* @param spliceInsertMessage
* This defines the SCTE-35 splice_insert() message inserted around the ad. For information
* about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder spliceInsertMessage(SpliceInsertMessage spliceInsertMessage);
/**
*
* This defines the SCTE-35 splice_insert() message inserted around the ad. For information about
* using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.
*
* This is a convenience method that creates an instance of the {@link SpliceInsertMessage.Builder} avoiding the
* need to create one manually via {@link SpliceInsertMessage#builder()}.
*
*
* When the {@link Consumer} completes, {@link SpliceInsertMessage.Builder#build()} is called immediately and
* its result is passed to {@link #spliceInsertMessage(SpliceInsertMessage)}.
*
* @param spliceInsertMessage
* a consumer that will call methods on {@link SpliceInsertMessage.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #spliceInsertMessage(SpliceInsertMessage)
*/
default Builder spliceInsertMessage(Consumer spliceInsertMessage) {
return spliceInsertMessage(SpliceInsertMessage.builder().applyMutation(spliceInsertMessage).build());
}
/**
*
* Defines the SCTE-35 time_signal message inserted around the ad.
*
*
* Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a
* splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad
* break.
*
*
* See section 9.7.4 of the 2022 SCTE-35 specification for more information.
*
*
* @param timeSignalMessage
* Defines the SCTE-35 time_signal message inserted around the ad.
*
* Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a
* splice_insert SCTE-35 message to the ad break. This message provides basic metadata about
* the ad break.
*
*
* See section 9.7.4 of the 2022 SCTE-35 specification for more information.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder timeSignalMessage(TimeSignalMessage timeSignalMessage);
/**
*
* Defines the SCTE-35 time_signal message inserted around the ad.
*
*
* Programs on a channel's schedule can be configured with one or more ad breaks. You can attach a
* splice_insert SCTE-35 message to the ad break. This message provides basic metadata about the ad
* break.
*
*
* See section 9.7.4 of the 2022 SCTE-35 specification for more information.
*
* This is a convenience method that creates an instance of the {@link TimeSignalMessage.Builder} avoiding the
* need to create one manually via {@link TimeSignalMessage#builder()}.
*
*
* When the {@link Consumer} completes, {@link TimeSignalMessage.Builder#build()} is called immediately and its
* result is passed to {@link #timeSignalMessage(TimeSignalMessage)}.
*
* @param timeSignalMessage
* a consumer that will call methods on {@link TimeSignalMessage.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #timeSignalMessage(TimeSignalMessage)
*/
default Builder timeSignalMessage(Consumer timeSignalMessage) {
return timeSignalMessage(TimeSignalMessage.builder().applyMutation(timeSignalMessage).build());
}
}
static final class BuilderImpl implements Builder {
private List adBreakMetadata = DefaultSdkAutoConstructList.getInstance();
private String messageType;
private Long offsetMillis;
private SlateSource slate;
private SpliceInsertMessage spliceInsertMessage;
private TimeSignalMessage timeSignalMessage;
private BuilderImpl() {
}
private BuilderImpl(AdBreak model) {
adBreakMetadata(model.adBreakMetadata);
messageType(model.messageType);
offsetMillis(model.offsetMillis);
slate(model.slate);
spliceInsertMessage(model.spliceInsertMessage);
timeSignalMessage(model.timeSignalMessage);
}
public final List getAdBreakMetadata() {
List result = AdBreakMetadataListCopier.copyToBuilder(this.adBreakMetadata);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAdBreakMetadata(Collection adBreakMetadata) {
this.adBreakMetadata = AdBreakMetadataListCopier.copyFromBuilder(adBreakMetadata);
}
@Override
public final Builder adBreakMetadata(Collection adBreakMetadata) {
this.adBreakMetadata = AdBreakMetadataListCopier.copy(adBreakMetadata);
return this;
}
@Override
@SafeVarargs
public final Builder adBreakMetadata(KeyValuePair... adBreakMetadata) {
adBreakMetadata(Arrays.asList(adBreakMetadata));
return this;
}
@Override
@SafeVarargs
public final Builder adBreakMetadata(Consumer... adBreakMetadata) {
adBreakMetadata(Stream.of(adBreakMetadata).map(c -> KeyValuePair.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getMessageType() {
return messageType;
}
public final void setMessageType(String messageType) {
this.messageType = messageType;
}
@Override
public final Builder messageType(String messageType) {
this.messageType = messageType;
return this;
}
@Override
public final Builder messageType(MessageType messageType) {
this.messageType(messageType == null ? null : messageType.toString());
return this;
}
public final Long getOffsetMillis() {
return offsetMillis;
}
public final void setOffsetMillis(Long offsetMillis) {
this.offsetMillis = offsetMillis;
}
@Override
public final Builder offsetMillis(Long offsetMillis) {
this.offsetMillis = offsetMillis;
return this;
}
public final SlateSource.Builder getSlate() {
return slate != null ? slate.toBuilder() : null;
}
public final void setSlate(SlateSource.BuilderImpl slate) {
this.slate = slate != null ? slate.build() : null;
}
@Override
public final Builder slate(SlateSource slate) {
this.slate = slate;
return this;
}
public final SpliceInsertMessage.Builder getSpliceInsertMessage() {
return spliceInsertMessage != null ? spliceInsertMessage.toBuilder() : null;
}
public final void setSpliceInsertMessage(SpliceInsertMessage.BuilderImpl spliceInsertMessage) {
this.spliceInsertMessage = spliceInsertMessage != null ? spliceInsertMessage.build() : null;
}
@Override
public final Builder spliceInsertMessage(SpliceInsertMessage spliceInsertMessage) {
this.spliceInsertMessage = spliceInsertMessage;
return this;
}
public final TimeSignalMessage.Builder getTimeSignalMessage() {
return timeSignalMessage != null ? timeSignalMessage.toBuilder() : null;
}
public final void setTimeSignalMessage(TimeSignalMessage.BuilderImpl timeSignalMessage) {
this.timeSignalMessage = timeSignalMessage != null ? timeSignalMessage.build() : null;
}
@Override
public final Builder timeSignalMessage(TimeSignalMessage timeSignalMessage) {
this.timeSignalMessage = timeSignalMessage;
return this;
}
@Override
public AdBreak build() {
return new AdBreak(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}