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

Interface ClipTimestampRange.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ClipTimestampRange.Builder,ClipTimestampRange>, SdkBuilder<ClipTimestampRange.Builder,ClipTimestampRange>, SdkPojo

Enclosing class:

ClipTimestampRange

public static interface ClipTimestampRange.Builder
extends SdkPojo, CopyableBuilder<ClipTimestampRange.Builder,ClipTimestampRange>

Method Summary

Modifier and Type	Method	Description
ClipTimestampRange.Builder	endTimestamp(Instant endTimestamp)	The end of the timestamp range for the requested media.
ClipTimestampRange.Builder	startTimestamp(Instant startTimestamp)	The starting timestamp in the range of timestamps for which to return fragments.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

startTimestamp

ClipTimestampRange.Builder startTimestamp(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

endTimestamp

ClipTimestampRange.Builder endTimestamp(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.