/* * Copyright 2018-2023 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.kinesisvideo.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The start and end of the timestamp range for the requested media. *

*

* This value should not be present if PlaybackType is LIVE. *

* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class HLSTimestampRange implements Serializable, Cloneable, StructuredPojo { /** *

* The start of the timestamp range for the requested media. *

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments * that start before StartTimestamp and continue past it aren't included in the session. If * FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later * than the stream head. *

*/ private java.util.Date startTimestamp; /** *

* The end of the timestamp range for the requested media. This value must be within 24 hours of the specified * StartTimestamp, and it must be later than the StartTimestamp value. *

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the * past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then * the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. * Fragments that start before the EndTimestamp value and continue past it are included in the session. *

* */ private java.util.Date endTimestamp; /** *

* The start of the timestamp range for the requested media. *

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments * that start before StartTimestamp and continue past it aren't included in the session. If * FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later * than the stream head. *

* * @param startTimestamp * The start of the timestamp range for the requested media.

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is * required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. * Fragments that start before StartTimestamp and continue past it aren't included in the * session. If FragmentSelectorType is SERVER_TIMESTAMP, the * StartTimestamp must be later than the stream head. */ public void setStartTimestamp(java.util.Date startTimestamp) { this.startTimestamp = startTimestamp; } /** *

* The start of the timestamp range for the requested media. *

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments * that start before StartTimestamp and continue past it aren't included in the session. If * FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later * than the stream head. *

* * @return The start of the timestamp range for the requested media.

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is * required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. * Fragments that start before StartTimestamp and continue past it aren't included in the * session. If FragmentSelectorType is SERVER_TIMESTAMP, the * StartTimestamp must be later than the stream head. */ public java.util.Date getStartTimestamp() { return this.startTimestamp; } /** *

* The start of the timestamp range for the requested media. *

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. Fragments * that start before StartTimestamp and continue past it aren't included in the session. If * FragmentSelectorType is SERVER_TIMESTAMP, the StartTimestamp must be later * than the stream head. *

* * @param startTimestamp * The start of the timestamp range for the requested media.

*

* If the HLSTimestampRange value is specified, the StartTimestamp value is * required. *

*

* Only fragments that start exactly at or after StartTimestamp are included in the session. * Fragments that start before StartTimestamp and continue past it aren't included in the * session. If FragmentSelectorType is SERVER_TIMESTAMP, the * StartTimestamp must be later than the stream head. * @return Returns a reference to this object so that method calls can be chained together. */ public HLSTimestampRange withStartTimestamp(java.util.Date startTimestamp) { setStartTimestamp(startTimestamp); return this; } /** *

* The end of the timestamp range for the requested media. This value must be within 24 hours of the specified * StartTimestamp, and it must be later than the StartTimestamp value. *

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the * past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then * the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. * Fragments that start before the EndTimestamp value and continue past it are included in the session. *

* * * @param endTimestamp * The end of the timestamp range for the requested media. This value must be within 24 hours of the * specified StartTimestamp, and it must be later than the StartTimestamp * value.

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be * in the past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY * mode then the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the * fragment. Fragments that start before the EndTimestamp value and continue past it are * included in the session. *

*/ public void setEndTimestamp(java.util.Date endTimestamp) { this.endTimestamp = endTimestamp; } /** *

* The end of the timestamp range for the requested media. This value must be within 24 hours of the specified * StartTimestamp, and it must be later than the StartTimestamp value. *

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the * past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then * the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. * Fragments that start before the EndTimestamp value and continue past it are included in the session. *

* * * @return The end of the timestamp range for the requested media. This value must be within 24 hours of the * specified StartTimestamp, and it must be later than the StartTimestamp * value.

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be * in the past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY * mode then the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the * fragment. Fragments that start before the EndTimestamp value and continue past it are * included in the session. *

*/ public java.util.Date getEndTimestamp() { return this.endTimestamp; } /** *

* The end of the timestamp range for the requested media. This value must be within 24 hours of the specified * StartTimestamp, and it must be later than the StartTimestamp value. *

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be in the * past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY mode then * the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the fragment. * Fragments that start before the EndTimestamp value and continue past it are included in the session. *

* * * @param endTimestamp * The end of the timestamp range for the requested media. This value must be within 24 hours of the * specified StartTimestamp, and it must be later than the StartTimestamp * value.

*

* If FragmentSelectorType for the request is SERVER_TIMESTAMP, this value must be * in the past. *

*

* The EndTimestamp value is required for ON_DEMAND mode, but optional for * LIVE_REPLAY mode. If the EndTimestamp is not set for LIVE_REPLAY * mode then the session will continue to include newly ingested fragments until the session expires. *

* *

* This value is inclusive. The EndTimestamp is compared to the (starting) timestamp of the * fragment. Fragments that start before the EndTimestamp value and continue past it are * included in the session. *

* @return Returns a reference to this object so that method calls can be chained together. */ public HLSTimestampRange withEndTimestamp(java.util.Date endTimestamp) { setEndTimestamp(endTimestamp); 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 (getStartTimestamp() != null) sb.append("StartTimestamp: ").append(getStartTimestamp()).append(","); if (getEndTimestamp() != null) sb.append("EndTimestamp: ").append(getEndTimestamp()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof HLSTimestampRange == false) return false; HLSTimestampRange other = (HLSTimestampRange) obj; if (other.getStartTimestamp() == null ^ this.getStartTimestamp() == null) return false; if (other.getStartTimestamp() != null && other.getStartTimestamp().equals(this.getStartTimestamp()) == false) return false; if (other.getEndTimestamp() == null ^ this.getEndTimestamp() == null) return false; if (other.getEndTimestamp() != null && other.getEndTimestamp().equals(this.getEndTimestamp()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStartTimestamp() == null) ? 0 : getStartTimestamp().hashCode()); hashCode = prime * hashCode + ((getEndTimestamp() == null) ? 0 : getEndTimestamp().hashCode()); return hashCode; } @Override public HLSTimestampRange clone() { try { return (HLSTimestampRange) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.kinesisvideo.model.transform.HLSTimestampRangeMarshaller.getInstance().marshall(this, protocolMarshaller); } }