com.amazonaws.services.kinesisvideoarchivedmedia.model

Class ListFragmentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ListFragmentsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Returns a list of Fragment objects from the specified stream and start location within the archived data.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ListFragmentsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
FragmentSelector	getFragmentSelector() Describes the time stamp range and time stamp origin for the range of fragments to return.
java.lang.Long	getMaxResults() The total number of fragments to return.
java.lang.String	getNextToken() A token to specify where to start paginating.
java.lang.String	getStreamName() The name of the stream from which to retrieve a fragment list.
int	hashCode()
void	setFragmentSelector(FragmentSelector fragmentSelector) Describes the time stamp range and time stamp origin for the range of fragments to return.
void	setMaxResults(java.lang.Long maxResults) The total number of fragments to return.
void	setNextToken(java.lang.String nextToken) A token to specify where to start paginating.
void	setStreamName(java.lang.String streamName) The name of the stream from which to retrieve a fragment list.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
ListFragmentsRequest	withFragmentSelector(FragmentSelector fragmentSelector) Describes the time stamp range and time stamp origin for the range of fragments to return.
ListFragmentsRequest	withMaxResults(java.lang.Long maxResults) The total number of fragments to return.
ListFragmentsRequest	withNextToken(java.lang.String nextToken) A token to specify where to start paginating.
ListFragmentsRequest	withStreamName(java.lang.String streamName) The name of the stream from which to retrieve a fragment list.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListFragmentsRequest

public ListFragmentsRequest()

Method Detail

getStreamName

public java.lang.String getStreamName()

The name of the stream from which to retrieve a fragment list.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream from which to retrieve a fragment list.

setStreamName

public void setStreamName(java.lang.String streamName)

The name of the stream from which to retrieve a fragment list.

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream from which to retrieve a fragment list.

withStreamName

public ListFragmentsRequest withStreamName(java.lang.String streamName)

The name of the stream from which to retrieve a fragment list.

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

Constraints:
Length: 1 - 256
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream from which to retrieve a fragment list.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public java.lang.Long getMaxResults()

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

Constraints:
Range: 1 - 1000

Returns:

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

setMaxResults

public void setMaxResults(java.lang.Long maxResults)

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

Constraints:
Range: 1 - 1000

Parameters:

maxResults -

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

withMaxResults

public ListFragmentsRequest withMaxResults(java.lang.Long maxResults)

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

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

Constraints:
Range: 1 - 1000

Parameters:

maxResults -

The total number of fragments to return. If the total number of fragments available is more than the value specified in max-results, then a ListFragmentsOutput$NextToken is provided in the output that you can use to resume pagination.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public java.lang.String getNextToken()

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

Constraints:
Length: 1 -

Returns:

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

setNextToken

public void setNextToken(java.lang.String nextToken)

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

Constraints:
Length: 1 -

Parameters:

nextToken -

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

withNextToken

public ListFragmentsRequest withNextToken(java.lang.String nextToken)

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

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

Constraints:
Length: 1 -

Parameters:

nextToken -

A token to specify where to start paginating. This is the ListFragmentsOutput$NextToken from a previously truncated response.

Returns:

A reference to this updated object so that method calls can be chained together.

getFragmentSelector

public FragmentSelector getFragmentSelector()

Describes the time stamp range and time stamp origin for the range of fragments to return.

Returns:

Describes the time stamp range and time stamp origin for the range of fragments to return.

setFragmentSelector

public void setFragmentSelector(FragmentSelector fragmentSelector)

Describes the time stamp range and time stamp origin for the range of fragments to return.

Parameters:

fragmentSelector -

Describes the time stamp range and time stamp origin for the range of fragments to return.

withFragmentSelector

public ListFragmentsRequest withFragmentSelector(FragmentSelector fragmentSelector)

Describes the time stamp range and time stamp origin for the range of fragments to return.

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

Parameters:

fragmentSelector -

Describes the time stamp range and time stamp origin for the range of fragments to return.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object