software.amazon.awssdk.services.mediatailor.model.AvailSuppression 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.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.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see
* Ad Suppression.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AvailSuppression implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField MODE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Mode")
.getter(getter(AvailSuppression::modeAsString)).setter(setter(Builder::mode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Mode").build()).build();
private static final SdkField VALUE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Value")
.getter(getter(AvailSuppression::value)).setter(setter(Builder::value))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Value").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(MODE_FIELD, VALUE_FIELD));
private static final long serialVersionUID = 1L;
private final String mode;
private final String value;
private AvailSuppression(BuilderImpl builder) {
this.mode = builder.mode;
this.value = builder.value;
}
/**
*
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate.
* When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks
* on or behind the ad suppression Value time in the manifest lookback window.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link Mode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or
* slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't
* fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
* @see Mode
*/
public final Mode mode() {
return Mode.fromValue(mode);
}
/**
*
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate.
* When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks
* on or behind the ad suppression Value time in the manifest lookback window.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #mode} will return
* {@link Mode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #modeAsString}.
*
*
* @return Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or
* slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't
* fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
* @see Mode
*/
public final String modeAsString() {
return mode;
}
/**
*
* A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest
* lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad
* breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind
* this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks
* that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the
* live edge.
*
*
* @return A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the
* manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor
* won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any
* ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then
* MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad
* breaks on or behind 45 minutes behind the live edge.
*/
public final String value() {
return value;
}
@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(modeAsString());
hashCode = 31 * hashCode + Objects.hashCode(value());
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 AvailSuppression)) {
return false;
}
AvailSuppression other = (AvailSuppression) obj;
return Objects.equals(modeAsString(), other.modeAsString()) && Objects.equals(value(), other.value());
}
/**
* 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("AvailSuppression").add("Mode", modeAsString()).add("Value", value()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Mode":
return Optional.ofNullable(clazz.cast(modeAsString()));
case "Value":
return Optional.ofNullable(clazz.cast(value()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AvailSuppression) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or
* slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill
* ad breaks on or behind the ad suppression Value time in the manifest lookback window.
*
*
* @param mode
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads
* or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor
* won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
* @see Mode
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
Builder mode(String mode);
/**
*
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or
* slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill
* ad breaks on or behind the ad suppression Value time in the manifest lookback window.
*
*
* @param mode
* Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads
* or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor
* won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.
* @see Mode
* @return Returns a reference to this object so that method calls can be chained together.
* @see Mode
*/
Builder mode(Mode mode);
/**
*
* A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest
* lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill
* any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or
* behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will
* fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45
* minutes behind the live edge.
*
*
* @param value
* A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the
* manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and
* MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor
* won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you
* set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge,
* but won't fill ad breaks on or behind 45 minutes behind the live edge.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder value(String value);
}
static final class BuilderImpl implements Builder {
private String mode;
private String value;
private BuilderImpl() {
}
private BuilderImpl(AvailSuppression model) {
mode(model.mode);
value(model.value);
}
public final String getMode() {
return mode;
}
public final void setMode(String mode) {
this.mode = mode;
}
@Override
public final Builder mode(String mode) {
this.mode = mode;
return this;
}
@Override
public final Builder mode(Mode mode) {
this.mode(mode == null ? null : mode.toString());
return this;
}
public final String getValue() {
return value;
}
public final void setValue(String value) {
this.value = value;
}
@Override
public final Builder value(String value) {
this.value = value;
return this;
}
@Override
public AvailSuppression build() {
return new AvailSuppression(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}