software.amazon.awssdk.services.mediatailor.model.LivePreRollConfiguration Maven / Gradle / Ivy

Go to download
/*
 * 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 pre-roll ad insertion.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
public final class LivePreRollConfiguration implements SdkPojo, Serializable,
        ToCopyableBuilder {
    private static final SdkField AD_DECISION_SERVER_URL_FIELD = SdkField. builder(MarshallingType.STRING)
            .memberName("AdDecisionServerUrl").getter(getter(LivePreRollConfiguration::adDecisionServerUrl))
            .setter(setter(Builder::adDecisionServerUrl))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AdDecisionServerUrl").build())
            .build();

    private static final SdkField MAX_DURATION_SECONDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
            .memberName("MaxDurationSeconds").getter(getter(LivePreRollConfiguration::maxDurationSeconds))
            .setter(setter(Builder::maxDurationSeconds))
            .traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxDurationSeconds").build())
            .build();

    private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(AD_DECISION_SERVER_URL_FIELD,
            MAX_DURATION_SECONDS_FIELD));

    private static final long serialVersionUID = 1L;

    private final String adDecisionServerUrl;

    private final Integer maxDurationSeconds;

    private LivePreRollConfiguration(BuilderImpl builder) {
        this.adDecisionServerUrl = builder.adDecisionServerUrl;
        this.maxDurationSeconds = builder.maxDurationSeconds;
    }

    /**
     * 
     * The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters
     * and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and
     * session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static
     * VAST URL. The maximum length is 25,000 characters.
     * 
     * 
     * @return The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static
     *         parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific
     *         and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide
     *         a static VAST URL. The maximum length is 25,000 characters.
     */
    public final String adDecisionServerUrl() {
        return adDecisionServerUrl;
    }

    /**
     * The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to
     * exceed this duration, regardless of the total duration of ads that the ADS returns.
     * 
     * @return The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads
     *         to exceed this duration, regardless of the total duration of ads that the ADS returns.
     */
    public final Integer maxDurationSeconds() {
        return maxDurationSeconds;
    }

    @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(adDecisionServerUrl());
        hashCode = 31 * hashCode + Objects.hashCode(maxDurationSeconds());
        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 LivePreRollConfiguration)) {
            return false;
        }
        LivePreRollConfiguration other = (LivePreRollConfiguration) obj;
        return Objects.equals(adDecisionServerUrl(), other.adDecisionServerUrl())
                && Objects.equals(maxDurationSeconds(), other.maxDurationSeconds());
    }

    /**
     * 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("LivePreRollConfiguration").add("AdDecisionServerUrl", adDecisionServerUrl())
                .add("MaxDurationSeconds", maxDurationSeconds()).build();
    }

    public final  Optional getValueForField(String fieldName, Class clazz) {
        switch (fieldName) {
        case "AdDecisionServerUrl":
            return Optional.ofNullable(clazz.cast(adDecisionServerUrl()));
        case "MaxDurationSeconds":
            return Optional.ofNullable(clazz.cast(maxDurationSeconds()));
        default:
            return Optional.empty();
        }
    }

    @Override
    public final List> sdkFields() {
        return SDK_FIELDS;
    }

    private static  Function getter(Function g) {
        return obj -> g.apply((LivePreRollConfiguration) obj);
    }

    private static  BiConsumer setter(BiConsumer s) {
        return (obj, val) -> s.accept((Builder) obj, val);
    }

    public interface Builder extends SdkPojo, CopyableBuilder {
        /**
         * 
         * The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static
         * parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and
         * session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a
         * static VAST URL. The maximum length is 25,000 characters.
         * 
         * 
         * @param adDecisionServerUrl
         *        The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static
         *        parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes
         *        player-specific and session-specific parameters as needed when calling the ADS. Alternately, for
         *        testing, you can provide a static VAST URL. The maximum length is 25,000 characters.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder adDecisionServerUrl(String adDecisionServerUrl);

        /**
         * The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to
         * exceed this duration, regardless of the total duration of ads that the ADS returns.
         * 
         * @param maxDurationSeconds
         *        The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll
         *        ads to exceed this duration, regardless of the total duration of ads that the ADS returns.
         * @return Returns a reference to this object so that method calls can be chained together.
         */
        Builder maxDurationSeconds(Integer maxDurationSeconds);
    }

    static final class BuilderImpl implements Builder {
        private String adDecisionServerUrl;

        private Integer maxDurationSeconds;

        private BuilderImpl() {
        }

        private BuilderImpl(LivePreRollConfiguration model) {
            adDecisionServerUrl(model.adDecisionServerUrl);
            maxDurationSeconds(model.maxDurationSeconds);
        }

        public final String getAdDecisionServerUrl() {
            return adDecisionServerUrl;
        }

        public final void setAdDecisionServerUrl(String adDecisionServerUrl) {
            this.adDecisionServerUrl = adDecisionServerUrl;
        }

        @Override
        public final Builder adDecisionServerUrl(String adDecisionServerUrl) {
            this.adDecisionServerUrl = adDecisionServerUrl;
            return this;
        }

        public final Integer getMaxDurationSeconds() {
            return maxDurationSeconds;
        }

        public final void setMaxDurationSeconds(Integer maxDurationSeconds) {
            this.maxDurationSeconds = maxDurationSeconds;
        }

        @Override
        public final Builder maxDurationSeconds(Integer maxDurationSeconds) {
            this.maxDurationSeconds = maxDurationSeconds;
            return this;
        }

        @Override
        public LivePreRollConfiguration build() {
            return new LivePreRollConfiguration(this);
        }

        @Override
        public List> sdkFields() {
            return SDK_FIELDS;
        }
    }
}