DeleteBytesRequest.Builder

Page Summary

• DeleteBytesRequest.Builder is used to construct DeleteBytesRequest objects for deleting Block Store data.

• You can specify to delete all data or delete data associated with a specific list of keys.

• Using setDeleteAll(true) and providing a list of keys will result in an IllegalStateException.

public static final class DeleteBytesRequest.Builder extends Object

A builder for DeleteBytesRequest objects.

Public Constructor Summary

Builder() Constructor for the DeleteBytesRequest.Builder class.

Public Method Summary

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

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder ()

Constructor for the DeleteBytesRequest.Builder class.

Public Methods

public DeleteBytesRequest build ()

Builds and returns the DeleteBytesRequest object.

public DeleteBytesRequest.Builder setDeleteAll (boolean deleteAll)

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

The default is false.

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

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

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

The default value is an empty list, which means that no key-based filtering will be performed. In other words, no data will be deleted 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 deleted with the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.