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

Class GetMediaForFragmentListRequest

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.GetMediaForFragmentListRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetMediaForFragmentListRequest.Builder,GetMediaForFragmentListRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetMediaForFragmentListRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetMediaForFragmentListRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fragments()	A list of the numbers of fragments for which to retrieve media.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFragments()	For responses, this returns true if the service returned a value for the Fragments property.
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetMediaForFragmentListRequest.Builder>	serializableBuilderClass()
String	streamARN()	The Amazon Resource Name (ARN) of the stream from which to retrieve fragment media.
String	streamName()	The name of the stream from which to retrieve fragment media.
GetMediaForFragmentListRequest.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 fragment media. Specify either this parameter or the StreamARN parameter.

Returns:

The name of the stream from which to retrieve fragment media. 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 fragment media. Specify either this parameter or the StreamName parameter.

Returns:

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

hasFragments

public final boolean hasFragments()

For responses, this returns true if the service returned a value for the Fragments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

fragments

public final List<String> fragments()

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFragments() method.

Returns:

A list of the numbers of fragments for which to retrieve media. You retrieve these values with ListFragments.

toBuilder

public GetMediaForFragmentListRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetMediaForFragmentListRequest.Builder,GetMediaForFragmentListRequest>

Specified by:

toBuilder in class KinesisVideoArchivedMediaRequest

builder

public static GetMediaForFragmentListRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetMediaForFragmentListRequest.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