RetrieveBytesRequest.Builder

public static final class RetrieveBytesRequest.Builder extends Object

A builder for RetrieveBytesRequest objects.

Public Constructor Summary

Builder()
Constructor for the RetrieveBytesRequest.Builder class.

Public Method Summary

RetrieveBytesRequest
build()
Builds and returns the RetrieveBytesRequest object.
RetrieveBytesRequest.Builder
setKeys(List<String> keys)
Sets the list of keys whose associated data, if any, should be retrieved.
RetrieveBytesRequest.Builder
setRetrieveAll(boolean retrieveAll)
Sets whether or not all app's Block Store data should be retrieved.

Inherited Method Summary

Public Constructors

public Builder ()

Constructor for the RetrieveBytesRequest.Builder class.

Public Methods

public RetrieveBytesRequest build ()

Builds and returns the RetrieveBytesRequest object.

public RetrieveBytesRequest.Builder setKeys (List<String> keys)

Sets the list of keys whose associated data, if any, should be retrieved.

The default value is an empty list, which means that no key-based filtering will be performed. In other words, no data will be returned if the key list is empty and no other criterion is provided.

Note that the app data that was stored without an explicit key can be requested with the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.

public RetrieveBytesRequest.Builder setRetrieveAll (boolean retrieveAll)

Sets whether or not all app's Block Store data should be retrieved.

The default is false.

Note that if retrieveAll is set to true, then you should NOT set any other retrieval criterion, e.g. keys should be empty. Otherwise, an IllegalStateException will be thrown.