@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 timestamp (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.
Constructor and Description |
---|
StartSelector() |
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 timestamp value.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
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 timestamp 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 timestamp value.
|
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server timestamp. You specify the timestamp 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
.
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server timestamp. You specify the timestamp 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
.
StartSelectorType
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server timestamp. You specify the timestamp 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
.
NOW - Start with the latest chunk on the stream.
EARLIEST - Start with earliest available chunk on the stream.
FRAGMENT_NUMBER - Start with the chunk after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server timestamp. You specify the timestamp 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
.
StartSelectorType
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server timestamp. You specify the timestamp 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
.
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server timestamp. You specify the timestamp 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
.
StartSelectorType
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified producer
or server timestamp. You specify the timestamp 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
.
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 after a specific fragment. You must also specify the
AfterFragmentNumber
parameter.
PRODUCER_TIMESTAMP or SERVER_TIMESTAMP - Start with the chunk containing a fragment with the specified
producer or server timestamp. You specify the timestamp 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
.
StartSelectorType
public void setAfterFragmentNumber(String afterFragmentNumber)
Specifies the fragment number from where you want the GetMedia
API to start returning the fragments.
afterFragmentNumber
- Specifies the fragment number from where you want the GetMedia
API to start returning the
fragments.public String getAfterFragmentNumber()
Specifies the fragment number from where you want the GetMedia
API to start returning the fragments.
GetMedia
API to start returning the
fragments.public StartSelector withAfterFragmentNumber(String afterFragmentNumber)
Specifies the fragment number from where you want the GetMedia
API to start returning the fragments.
afterFragmentNumber
- Specifies the fragment number from where you want the GetMedia
API to start returning the
fragments.public void setStartTimestamp(Date startTimestamp)
A timestamp 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 timestamp.
startTimestamp
- A timestamp 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 timestamp.public Date getStartTimestamp()
A timestamp 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 timestamp.
startSelectorType
. The GetMedia
API then starts with the chunk containing
the fragment that has the specified timestamp.public StartSelector withStartTimestamp(Date startTimestamp)
A timestamp 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 timestamp.
startTimestamp
- A timestamp 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 timestamp.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.
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.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.
GetMedia
response.
The GetMedia
API then starts with the chunk identified by the continuation token.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.
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.public String toString()
toString
in class Object
Object.toString()
public StartSelector clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.