software.amazon.awssdk.services.mediatailor.model.PrefetchSchedule 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.Consumer;
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;
/**
*
* A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For
* more information about ad prefetching, see Using ad prefetching in the
* MediaTailor User Guide.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PrefetchSchedule implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Arn")
.getter(getter(PrefetchSchedule::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Arn").build()).build();
private static final SdkField CONSUMPTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Consumption")
.getter(getter(PrefetchSchedule::consumption)).setter(setter(Builder::consumption))
.constructor(PrefetchConsumption::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Consumption").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(PrefetchSchedule::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField PLAYBACK_CONFIGURATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PlaybackConfigurationName").getter(getter(PrefetchSchedule::playbackConfigurationName))
.setter(setter(Builder::playbackConfigurationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PlaybackConfigurationName").build())
.build();
private static final SdkField RETRIEVAL_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Retrieval")
.getter(getter(PrefetchSchedule::retrieval)).setter(setter(Builder::retrieval))
.constructor(PrefetchRetrieval::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Retrieval").build()).build();
private static final SdkField STREAM_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StreamId").getter(getter(PrefetchSchedule::streamId)).setter(setter(Builder::streamId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StreamId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, CONSUMPTION_FIELD,
NAME_FIELD, PLAYBACK_CONFIGURATION_NAME_FIELD, RETRIEVAL_FIELD, STREAM_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final PrefetchConsumption consumption;
private final String name;
private final String playbackConfigurationName;
private final PrefetchRetrieval retrieval;
private final String streamId;
private PrefetchSchedule(BuilderImpl builder) {
this.arn = builder.arn;
this.consumption = builder.consumption;
this.name = builder.name;
this.playbackConfigurationName = builder.playbackConfigurationName;
this.retrieval = builder.retrieval;
this.streamId = builder.streamId;
}
/**
*
* The Amazon Resource Name (ARN) of the prefetch schedule.
*
*
* @return The Amazon Resource Name (ARN) of the prefetch schedule.
*/
public final String arn() {
return arn;
}
/**
*
* Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad
* consumption occurs within a span of time that you define, called a consumption window. You can designate
* which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
*
*
* @return Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad
* consumption occurs within a span of time that you define, called a consumption window. You can
* designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
*/
public final PrefetchConsumption consumption() {
return consumption;
}
/**
*
* The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with
* the specified playback configuration.
*
*
* @return The name of the prefetch schedule. The name must be unique among all prefetch schedules that are
* associated with the specified playback configuration.
*/
public final String name() {
return name;
}
/**
*
* The name of the playback configuration to create the prefetch schedule for.
*
*
* @return The name of the playback configuration to create the prefetch schedule for.
*/
public final String playbackConfigurationName() {
return playbackConfigurationName;
}
/**
*
* A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
*
*
* @return A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
*/
public final PrefetchRetrieval retrieval() {
return retrieval;
}
/**
*
* An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same
* playback configuration.
*
*
* @return An optional stream identifier that you can specify in order to prefetch for multiple streams that use the
* same playback configuration.
*/
public final String streamId() {
return streamId;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(consumption());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(playbackConfigurationName());
hashCode = 31 * hashCode + Objects.hashCode(retrieval());
hashCode = 31 * hashCode + Objects.hashCode(streamId());
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 PrefetchSchedule)) {
return false;
}
PrefetchSchedule other = (PrefetchSchedule) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(consumption(), other.consumption())
&& Objects.equals(name(), other.name())
&& Objects.equals(playbackConfigurationName(), other.playbackConfigurationName())
&& Objects.equals(retrieval(), other.retrieval()) && Objects.equals(streamId(), other.streamId());
}
/**
* 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("PrefetchSchedule").add("Arn", arn()).add("Consumption", consumption()).add("Name", name())
.add("PlaybackConfigurationName", playbackConfigurationName()).add("Retrieval", retrieval())
.add("StreamId", streamId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Arn":
return Optional.ofNullable(clazz.cast(arn()));
case "Consumption":
return Optional.ofNullable(clazz.cast(consumption()));
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "PlaybackConfigurationName":
return Optional.ofNullable(clazz.cast(playbackConfigurationName()));
case "Retrieval":
return Optional.ofNullable(clazz.cast(retrieval()));
case "StreamId":
return Optional.ofNullable(clazz.cast(streamId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PrefetchSchedule) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The Amazon Resource Name (ARN) of the prefetch schedule.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the prefetch schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder arn(String arn);
/**
*
* Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad
* consumption occurs within a span of time that you define, called a consumption window. You can
* designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
*
*
* @param consumption
* Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad
* consumption occurs within a span of time that you define, called a consumption window. You can
* designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consumption(PrefetchConsumption consumption);
/**
*
* Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad
* consumption occurs within a span of time that you define, called a consumption window. You can
* designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.
*
* This is a convenience method that creates an instance of the {@link PrefetchConsumption.Builder} avoiding the
* need to create one manually via {@link PrefetchConsumption#builder()}.
*
*
* When the {@link Consumer} completes, {@link PrefetchConsumption.Builder#build()} is called immediately and
* its result is passed to {@link #consumption(PrefetchConsumption)}.
*
* @param consumption
* a consumer that will call methods on {@link PrefetchConsumption.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #consumption(PrefetchConsumption)
*/
default Builder consumption(Consumer consumption) {
return consumption(PrefetchConsumption.builder().applyMutation(consumption).build());
}
/**
*
* The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated
* with the specified playback configuration.
*
*
* @param name
* The name of the prefetch schedule. The name must be unique among all prefetch schedules that are
* associated with the specified playback configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The name of the playback configuration to create the prefetch schedule for.
*
*
* @param playbackConfigurationName
* The name of the playback configuration to create the prefetch schedule for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder playbackConfigurationName(String playbackConfigurationName);
/**
*
* A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
*
*
* @param retrieval
* A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retrieval(PrefetchRetrieval retrieval);
/**
*
* A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).
*
* This is a convenience method that creates an instance of the {@link PrefetchRetrieval.Builder} avoiding the
* need to create one manually via {@link PrefetchRetrieval#builder()}.
*
*
* When the {@link Consumer} completes, {@link PrefetchRetrieval.Builder#build()} is called immediately and its
* result is passed to {@link #retrieval(PrefetchRetrieval)}.
*
* @param retrieval
* a consumer that will call methods on {@link PrefetchRetrieval.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #retrieval(PrefetchRetrieval)
*/
default Builder retrieval(Consumer retrieval) {
return retrieval(PrefetchRetrieval.builder().applyMutation(retrieval).build());
}
/**
*
* An optional stream identifier that you can specify in order to prefetch for multiple streams that use the
* same playback configuration.
*
*
* @param streamId
* An optional stream identifier that you can specify in order to prefetch for multiple streams that use
* the same playback configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamId(String streamId);
}
static final class BuilderImpl implements Builder {
private String arn;
private PrefetchConsumption consumption;
private String name;
private String playbackConfigurationName;
private PrefetchRetrieval retrieval;
private String streamId;
private BuilderImpl() {
}
private BuilderImpl(PrefetchSchedule model) {
arn(model.arn);
consumption(model.consumption);
name(model.name);
playbackConfigurationName(model.playbackConfigurationName);
retrieval(model.retrieval);
streamId(model.streamId);
}
public final String getArn() {
return arn;
}
public final void setArn(String arn) {
this.arn = arn;
}
@Override
public final Builder arn(String arn) {
this.arn = arn;
return this;
}
public final PrefetchConsumption.Builder getConsumption() {
return consumption != null ? consumption.toBuilder() : null;
}
public final void setConsumption(PrefetchConsumption.BuilderImpl consumption) {
this.consumption = consumption != null ? consumption.build() : null;
}
@Override
public final Builder consumption(PrefetchConsumption consumption) {
this.consumption = consumption;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getPlaybackConfigurationName() {
return playbackConfigurationName;
}
public final void setPlaybackConfigurationName(String playbackConfigurationName) {
this.playbackConfigurationName = playbackConfigurationName;
}
@Override
public final Builder playbackConfigurationName(String playbackConfigurationName) {
this.playbackConfigurationName = playbackConfigurationName;
return this;
}
public final PrefetchRetrieval.Builder getRetrieval() {
return retrieval != null ? retrieval.toBuilder() : null;
}
public final void setRetrieval(PrefetchRetrieval.BuilderImpl retrieval) {
this.retrieval = retrieval != null ? retrieval.build() : null;
}
@Override
public final Builder retrieval(PrefetchRetrieval retrieval) {
this.retrieval = retrieval;
return this;
}
public final String getStreamId() {
return streamId;
}
public final void setStreamId(String streamId) {
this.streamId = streamId;
}
@Override
public final Builder streamId(String streamId) {
this.streamId = streamId;
return this;
}
@Override
public PrefetchSchedule build() {
return new PrefetchSchedule(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}