Package software.amazon.awssdk.services.kinesisvideoarchivedmedia.model

Class ClipTimestampRange

java.lang.Object

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ClipTimestampRange

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClipTimestampRange.Builder,ClipTimestampRange>

@Generated("software.amazon.awssdk:codegen")
public final class ClipTimestampRange
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClipTimestampRange.Builder,ClipTimestampRange>

The range of timestamps for which to return fragments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClipTimestampRange.Builder

Method Summary

Modifier and Type	Method	Description
static ClipTimestampRange.Builder	builder()
Instant	endTimestamp()	The end of the timestamp range for the requested media.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ClipTimestampRange.Builder>	serializableBuilderClass()
Instant	startTimestamp()	The starting timestamp in the range of timestamps for which to return fragments.
ClipTimestampRange.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

startTimestamp

public final Instant startTimestamp()

The starting timestamp in the range of timestamps for which to return fragments.

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.

Returns:

The starting timestamp in the range of timestamps for which to return fragments.

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.

endTimestamp

public final Instant 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.

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.

Returns:

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.

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.

toBuilder

public ClipTimestampRange.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClipTimestampRange.Builder,ClipTimestampRange>

builder

public static ClipTimestampRange.Builder builder()

serializableBuilderClass

public static Class<? extends ClipTimestampRange.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo