Package software.amazon.awssdk.services.mediastoredata.model

Class ListItemsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mediastoredata.model.MediaStoreDataRequest

software.amazon.awssdk.services.mediastoredata.model.ListItemsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListItemsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListItemsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return per API request.
String	nextToken()	The token that identifies which batch of results that you want to see.
String	path()	The path in the container from which to retrieve items.
List<SdkField<?>>	sdkFields()
static Class<? extends ListItemsRequest.Builder>	serializableBuilderClass()
ListItemsRequest.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

path

public final String path()

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

Returns:

The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

maxResults

public final Integer maxResults()

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

Returns:

The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

nextToken

public final String nextToken()

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

Returns:

The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

Tokens expire after 15 minutes.

toBuilder

public ListItemsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListItemsRequest.Builder,ListItemsRequest>

Specified by:

toBuilder in class MediaStoreDataRequest

builder

public static ListItemsRequest.Builder builder()

serializableBuilderClass

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