Class ListObjectsRequest

java.lang.Object

io.micronaut.objectstorage.request.ListObjectsRequest

public final class ListObjectsRequest
extends Object

Paginated object listing request.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
ListObjectsRequest(int pageSize)
ListObjectsRequest(int pageSize, @Nullable String prefix)
ListObjectsRequest(int pageSize, @Nullable String prefix, @Nullable String continuationToken)

Method Summary

Modifier and Type	Method	Description
@NonNull Optional<String>	getContinuationToken()
int	getPageSize()
@NonNull Optional<String>	getPrefix()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListObjectsRequest

public ListObjectsRequest(int pageSize)

Parameters:

pageSize - the maximum number of keys to return

ListObjectsRequest

public ListObjectsRequest(int pageSize,
 @Nullable String prefix)

Parameters:

pageSize - the maximum number of keys to return

prefix - the prefix to filter keys by

ListObjectsRequest

public ListObjectsRequest(int pageSize,
 @Nullable String prefix,
 @Nullable String continuationToken)

Parameters:

pageSize - the maximum number of keys to return

prefix - the prefix to filter keys by

continuationToken - the opaque continuation token for the next page

Method Details

getPageSize

public int getPageSize()

Returns:

the maximum number of keys to return

getPrefix

public @NonNull Optional<String> getPrefix()

Returns:

the prefix to filter keys by, if present

getContinuationToken

public @NonNull Optional<String> getContinuationToken()

Returns:

the opaque continuation token for the next page, if present