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(value="software.amazon.awssdk:codegen")
public final class ListFragmentsRequest
extends KinesisVideoArchivedMediaRequest
implements ToCopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListFragmentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListFragmentsRequest.Builder	builder()
boolean	equals(Object obj)
FragmentSelector	fragmentSelector() Describes the time stamp range and time stamp origin for the range of fragments to return.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Long	maxResults() The total number of fragments to return.
String	nextToken() A token to specify where to start paginating.
List<SdkField<?>>	sdkFields()
static Class<? extends ListFragmentsRequest.Builder>	serializableBuilderClass()
String	streamName() The name of the stream from which to retrieve a fragment list.
ListFragmentsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

streamName

public String streamName()

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

Returns:

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

maxResults

public 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 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 FragmentSelector fragmentSelector()

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.

toBuilder

public ListFragmentsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListFragmentsRequest.Builder,ListFragmentsRequest>

Specified by:

toBuilder in class KinesisVideoArchivedMediaRequest

Returns:

a builder for type T

builder

public static ListFragmentsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.