com.amazonaws.services.mediatailor.model.CreatePrefetchScheduleResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-mediatailor Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.mediatailor.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreatePrefetchScheduleResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The ARN to assign to the prefetch schedule.
*
*/
private String arn;
/**
*
* 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.
*
*/
private PrefetchConsumption consumption;
/**
*
* The name to assign to the prefetch schedule.
*
*/
private String name;
/**
*
* The name to assign to the playback configuration.
*
*/
private 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.
*
*/
private PrefetchRetrieval 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.
*
*/
private String streamId;
/**
*
* The ARN to assign to the prefetch schedule.
*
*
* @param arn
* The ARN to assign to the prefetch schedule.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The ARN to assign to the prefetch schedule.
*
*
* @return The ARN to assign to the prefetch schedule.
*/
public String getArn() {
return this.arn;
}
/**
*
* The ARN to assign to the prefetch schedule.
*
*
* @param arn
* The ARN to assign to the prefetch schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePrefetchScheduleResult withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* 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.
*/
public void setConsumption(PrefetchConsumption consumption) {
this.consumption = 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 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 PrefetchConsumption getConsumption() {
return this.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.
*
*
* @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.
*/
public CreatePrefetchScheduleResult withConsumption(PrefetchConsumption consumption) {
setConsumption(consumption);
return this;
}
/**
*
* The name to assign to the prefetch schedule.
*
*
* @param name
* The name to assign to the prefetch schedule.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name to assign to the prefetch schedule.
*
*
* @return The name to assign to the prefetch schedule.
*/
public String getName() {
return this.name;
}
/**
*
* The name to assign to the prefetch schedule.
*
*
* @param name
* The name to assign to the prefetch schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePrefetchScheduleResult withName(String name) {
setName(name);
return this;
}
/**
*
* The name to assign to the playback configuration.
*
*
* @param playbackConfigurationName
* The name to assign to the playback configuration.
*/
public void setPlaybackConfigurationName(String playbackConfigurationName) {
this.playbackConfigurationName = playbackConfigurationName;
}
/**
*
* The name to assign to the playback configuration.
*
*
* @return The name to assign to the playback configuration.
*/
public String getPlaybackConfigurationName() {
return this.playbackConfigurationName;
}
/**
*
* 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.
*/
public CreatePrefetchScheduleResult withPlaybackConfigurationName(String playbackConfigurationName) {
setPlaybackConfigurationName(playbackConfigurationName);
return this;
}
/**
*
* 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.
*/
public void setRetrieval(PrefetchRetrieval retrieval) {
this.retrieval = 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 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 PrefetchRetrieval getRetrieval() {
return this.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.
*
*
* @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.
*/
public CreatePrefetchScheduleResult withRetrieval(PrefetchRetrieval retrieval) {
setRetrieval(retrieval);
return this;
}
/**
*
* 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.
*/
public void setStreamId(String streamId) {
this.streamId = 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 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 String getStreamId() {
return this.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.
*
*
* @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.
*/
public CreatePrefetchScheduleResult withStreamId(String streamId) {
setStreamId(streamId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getConsumption() != null)
sb.append("Consumption: ").append(getConsumption()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getPlaybackConfigurationName() != null)
sb.append("PlaybackConfigurationName: ").append(getPlaybackConfigurationName()).append(",");
if (getRetrieval() != null)
sb.append("Retrieval: ").append(getRetrieval()).append(",");
if (getStreamId() != null)
sb.append("StreamId: ").append(getStreamId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreatePrefetchScheduleResult == false)
return false;
CreatePrefetchScheduleResult other = (CreatePrefetchScheduleResult) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getConsumption() == null ^ this.getConsumption() == null)
return false;
if (other.getConsumption() != null && other.getConsumption().equals(this.getConsumption()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getPlaybackConfigurationName() == null ^ this.getPlaybackConfigurationName() == null)
return false;
if (other.getPlaybackConfigurationName() != null && other.getPlaybackConfigurationName().equals(this.getPlaybackConfigurationName()) == false)
return false;
if (other.getRetrieval() == null ^ this.getRetrieval() == null)
return false;
if (other.getRetrieval() != null && other.getRetrieval().equals(this.getRetrieval()) == false)
return false;
if (other.getStreamId() == null ^ this.getStreamId() == null)
return false;
if (other.getStreamId() != null && other.getStreamId().equals(this.getStreamId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getConsumption() == null) ? 0 : getConsumption().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getPlaybackConfigurationName() == null) ? 0 : getPlaybackConfigurationName().hashCode());
hashCode = prime * hashCode + ((getRetrieval() == null) ? 0 : getRetrieval().hashCode());
hashCode = prime * hashCode + ((getStreamId() == null) ? 0 : getStreamId().hashCode());
return hashCode;
}
@Override
public CreatePrefetchScheduleResult clone() {
try {
return (CreatePrefetchScheduleResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}