org.apache.hadoop.fs.s3a.s3guard

Class BulkOperationState

java.lang.Object

org.apache.hadoop.fs.s3a.s3guard.BulkOperationState

All Implemented Interfaces:

Closeable, AutoCloseable

public class BulkOperationState
extends Object
implements Closeable

This represents state which may be passed to bulk IO operations to enable them to store information about the state of the ongoing operation across invocations.

A bulk operation state MUST only be be used for the single store from which it was created, and MUSTonly for the duration of a single bulk update operation.

Passing in the state is to allow the stores to maintain state about updates they have already made to their store during this single operation: a cache of what has happened. It is not a list of operations to be applied. If a list of operations to perform is built up (e.g. during rename) that is the duty of the caller, not this state.

After the operation has completed, it MUST be closed so as to guarantee that all state is released.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BulkOperationState.OperationType Enumeration of operations which can be performed in bulk.

Constructor Summary

Constructors

Constructor and Description
BulkOperationState(BulkOperationState.OperationType operation) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close()
BulkOperationState.OperationType	getOperation() Get the operation type.

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkOperationState

public BulkOperationState(BulkOperationState.OperationType operation)

Constructor.

Parameters:

operation - the type of the operation.

Method Detail

getOperation

public BulkOperationState.OperationType getOperation()

Get the operation type.

Returns:

the operation type.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException