software.amazon.awssdk.services.mediatailor.model.CreatePrefetchScheduleRequest 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.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.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreatePrefetchScheduleRequest extends MediaTailorRequest implements
ToCopyableBuilder {
private static final SdkField CONSUMPTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Consumption")
.getter(getter(CreatePrefetchScheduleRequest::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(CreatePrefetchScheduleRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Name").build()).build();
private static final SdkField PLAYBACK_CONFIGURATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("PlaybackConfigurationName").getter(getter(CreatePrefetchScheduleRequest::playbackConfigurationName))
.setter(setter(Builder::playbackConfigurationName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("PlaybackConfigurationName").build())
.build();
private static final SdkField RETRIEVAL_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Retrieval")
.getter(getter(CreatePrefetchScheduleRequest::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(CreatePrefetchScheduleRequest::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(CONSUMPTION_FIELD, NAME_FIELD,
PLAYBACK_CONFIGURATION_NAME_FIELD, RETRIEVAL_FIELD, STREAM_ID_FIELD));
private final PrefetchConsumption consumption;
private final String name;
private final String playbackConfigurationName;
private final PrefetchRetrieval retrieval;
private final String streamId;
private CreatePrefetchScheduleRequest(BuilderImpl builder) {
super(builder);
this.consumption = builder.consumption;
this.name = builder.name;
this.playbackConfigurationName = builder.playbackConfigurationName;
this.retrieval = builder.retrieval;
this.streamId = builder.streamId;
}
/**
*
* The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision
* server. Each consumption configuration contains an end time and an optional start time that define the
* consumption window. Prefetch schedules automatically expire no earlier than seven days after the end time.
*
*
* @return The configuration settings for MediaTailor's consumption of the prefetched ads from the ad
* decision server. Each consumption configuration contains an end time and an optional start time that
* define the consumption window. Prefetch schedules automatically expire no earlier than seven days
* after the end time.
*/
public final PrefetchConsumption consumption() {
return consumption;
}
/**
*
* The name to assign to the schedule request.
*
*
* @return The name to assign to the schedule request.
*/
public final String name() {
return name;
}
/**
*
* The name to assign to the playback configuration.
*
*
* @return The name to assign to the playback configuration.
*/
public final String playbackConfigurationName() {
return playbackConfigurationName;
}
/**
*
* The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of
* prefetched ads will be retrieved and subsequently consumed for each ad break.
*
*
* @return The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of
* prefetched ads will be retrieved and subsequently consumed for each ad break.
*/
public final PrefetchRetrieval retrieval() {
return retrieval;
}
/**
*
* An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same
* playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch schedules
* with an exact match on StreamId. If not specified, MediaTailor returns all of the prefetch schedules
* for the playback configuration, regardless of StreamId.
*
*
* @return An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the
* same playback configuration. If StreamId is specified, MediaTailor returns all of the
* prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns
* all of the prefetch schedules for the playback configuration, regardless of StreamId.
*/
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 + super.hashCode();
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 super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreatePrefetchScheduleRequest)) {
return false;
}
CreatePrefetchScheduleRequest other = (CreatePrefetchScheduleRequest) obj;
return 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("CreatePrefetchScheduleRequest").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 "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((CreatePrefetchScheduleRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends MediaTailorRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision
* server. Each consumption configuration contains an end time and an optional start time that define the
* consumption window. Prefetch schedules automatically expire no earlier than seven days after the end
* time.
*
*
* @param consumption
* The configuration settings for MediaTailor's consumption of the prefetched ads from the ad
* decision server. Each consumption configuration contains an end time and an optional start time that
* define the consumption window. Prefetch schedules automatically expire no earlier than seven
* days after the end time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder consumption(PrefetchConsumption consumption);
/**
*
* The configuration settings for MediaTailor's consumption of the prefetched ads from the ad decision
* server. Each consumption configuration contains an end time and an optional start time that define the
* consumption window. Prefetch schedules automatically expire no earlier than seven days after the end
* time.
*
* 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 to assign to the schedule request.
*
*
* @param name
* The name to assign to the schedule request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The name to assign to the playback configuration.
*
*
* @param playbackConfigurationName
* The name to assign to the playback configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder playbackConfigurationName(String playbackConfigurationName);
/**
*
* The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of
* prefetched ads will be retrieved and subsequently consumed for each ad break.
*
*
* @param retrieval
* The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set
* of prefetched ads will be retrieved and subsequently consumed for each ad break.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder retrieval(PrefetchRetrieval retrieval);
/**
*
* The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of
* prefetched ads will be retrieved and subsequently consumed for each ad break.
*
* 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 MediaTailor uses to prefetch ads for multiple streams that use the same
* playback configuration. If StreamId is specified, MediaTailor returns all of the prefetch
* schedules with an exact match on StreamId. If not specified, MediaTailor returns all of the
* prefetch schedules for the playback configuration, regardless of StreamId.
*
*
* @param streamId
* An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the
* same playback configuration. If StreamId is specified, MediaTailor returns all of the
* prefetch schedules with an exact match on StreamId. If not specified, MediaTailor returns
* all of the prefetch schedules for the playback configuration, regardless of StreamId.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder streamId(String streamId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends MediaTailorRequest.BuilderImpl implements Builder {
private PrefetchConsumption consumption;
private String name;
private String playbackConfigurationName;
private PrefetchRetrieval retrieval;
private String streamId;
private BuilderImpl() {
}
private BuilderImpl(CreatePrefetchScheduleRequest model) {
super(model);
consumption(model.consumption);
name(model.name);
playbackConfigurationName(model.playbackConfigurationName);
retrieval(model.retrieval);
streamId(model.streamId);
}
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 Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePrefetchScheduleRequest build() {
return new CreatePrefetchScheduleRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}