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

Class ListFragmentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.KinesisVideoArchivedMediaRequest

software.amazon.awssdk.services.kinesisvideoarchivedmedia.model.ListFragmentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListFragmentsRequest
extends KinesisVideoArchivedMediaRequest
implements ToCopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListFragmentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListFragmentsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FragmentSelector	fragmentSelector()	Describes the timestamp range and timestamp origin for the range of fragments to return.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	maxResults()	The total number of fragments to return.
String	nextToken()	A token to specify where to start paginating.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListFragmentsRequest.Builder>	serializableBuilderClass()
String	streamARN()	The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list.
String	streamName()	The name of the stream from which to retrieve a fragment list.
ListFragmentsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

streamName

public final String streamName()

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

Returns:

The name of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamARN parameter.

streamARN

public final String streamARN()

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

Returns:

The Amazon Resource Name (ARN) of the stream from which to retrieve a fragment list. Specify either this parameter or the StreamName parameter.

maxResults

public final 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:

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.

nextToken

public final String nextToken()

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

Returns:

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

fragmentSelector

public final FragmentSelector fragmentSelector()

Describes the timestamp range and timestamp origin for the range of fragments to return.

This is only required when the NextToken isn't passed in the API.

Returns:

Describes the timestamp range and timestamp origin for the range of fragments to return.

This is only required when the NextToken isn't passed in the API.

toBuilder

public ListFragmentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

Specified by:

toBuilder in class KinesisVideoArchivedMediaRequest

builder

public static ListFragmentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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