com.amazonaws.services.kinesisvideo.model

Class StartSelector

java.lang.Object

com.amazonaws.services.kinesisvideo.model.StartSelector

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartSelector
extends Object
implements Serializable, Cloneable, StructuredPojo

Identifies the chunk on the Kinesis video stream where you want the GetMedia API to start returning media data. You have the following options to identify the starting chunk:

• Choose the latest (or oldest) chunk.

• Identify a specific chunk. You can identify a specific chunk either by providing a fragment number or time stamp (server or producer).

• Each chunk's metadata includes a continuation token as a Matroska (MKV) tag ( AWS_KINESISVIDEO_CONTINUATION_TOKEN). If your previous GetMedia request terminated, you can use this tag value in your next GetMedia request. The API then starts returning chunks starting where the last API ended.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartSelector()

Method Summary

Modifier and Type	Method and Description
StartSelector	clone()
boolean	equals(Object obj)
String	getAfterFragmentNumber() Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
String	getContinuationToken() Continuation token that Kinesis Video Streams returned in the previous GetMedia response.
String	getStartSelectorType() Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
Date	getStartTimestamp() A time stamp value.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAfterFragmentNumber(String afterFragmentNumber) Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
void	setContinuationToken(String continuationToken) Continuation token that Kinesis Video Streams returned in the previous GetMedia response.
void	setStartSelectorType(String startSelectorType) Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
void	setStartTimestamp(Date startTimestamp) A time stamp value.
String	toString() Returns a string representation of this object.
StartSelector	withAfterFragmentNumber(String afterFragmentNumber) Specifies the fragment number from where you want the GetMedia API to start returning the fragments.
StartSelector	withContinuationToken(String continuationToken) Continuation token that Kinesis Video Streams returned in the previous GetMedia response.
StartSelector	withStartSelectorType(StartSelectorType startSelectorType) Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
StartSelector	withStartSelectorType(String startSelectorType) Identifies the fragment on the Kinesis video stream where you want to start getting the data from.
StartSelector	withStartTimestamp(Date startTimestamp) A time stamp value.

Methods inherited from class java.lang.Object

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

Constructor Detail

StartSelector

public StartSelector()

Method Detail

setStartSelectorType

public void setStartSelectorType(String startSelectorType)

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Parameters:

startSelectorType - Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

See Also:

StartSelectorType

getStartSelectorType

public String getStartSelectorType()

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Returns:

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

See Also:

StartSelectorType

withStartSelectorType

public StartSelector withStartSelectorType(String startSelectorType)

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Parameters:

startSelectorType - Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Returns:

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

See Also:

StartSelectorType

withStartSelectorType

public StartSelector withStartSelectorType(StartSelectorType startSelectorType)

Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Parameters:

startSelectorType - Identifies the fragment on the Kinesis video stream where you want to start getting the data from.

• NOW - Start with the latest chunk on the stream.

• EARLIEST - Start with earliest available chunk on the stream.

• FRAGMENT_NUMBER - Start with the chunk containing the specific fragment. You must also specify the StartFragmentNumber.

• PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer or server time stamp. You specify the time stamp by adding StartTimestamp.

• CONTINUATION_TOKEN - Read using the specified continuation token.

If you choose the NOW, EARLIEST, or CONTINUATION_TOKEN as the startSelectorType, you don't provide any additional information in the startSelector.

Returns:

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

See Also:

StartSelectorType

setAfterFragmentNumber

public void setAfterFragmentNumber(String afterFragmentNumber)

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

Parameters:

afterFragmentNumber - Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

getAfterFragmentNumber

public String getAfterFragmentNumber()

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

Returns:

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

withAfterFragmentNumber

public StartSelector withAfterFragmentNumber(String afterFragmentNumber)

Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

Parameters:

afterFragmentNumber - Specifies the fragment number from where you want the GetMedia API to start returning the fragments.

Returns:

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

setStartTimestamp

public void setStartTimestamp(Date startTimestamp)

A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

Parameters:

startTimestamp - A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

getStartTimestamp

public Date getStartTimestamp()

A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

Returns:

A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

withStartTimestamp

public StartSelector withStartTimestamp(Date startTimestamp)

A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

Parameters:

startTimestamp - A time stamp value. This value is required if you choose the PRODUCER_TIMESTAMP or the SERVER_TIMESTAMP as the startSelectorType. The GetMedia API then starts with the chunk containing the fragment that has the specified time stamp.

Returns:

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

setContinuationToken

public void setContinuationToken(String continuationToken)

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

Parameters:

continuationToken - Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

getContinuationToken

public String getContinuationToken()

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

Returns:

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

withContinuationToken

public StartSelector withContinuationToken(String continuationToken)

Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

Parameters:

continuationToken - Continuation token that Kinesis Video Streams returned in the previous GetMedia response. The GetMedia API then starts with the chunk identified by the continuation token.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartSelector clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo