Package org.apache.opendal

Class Operator

java.lang.Object

org.apache.opendal.NativeObject

org.apache.opendal.Operator

All Implemented Interfaces:

AutoCloseable

public class Operator
extends NativeObject

Operator represents an underneath OpenDAL operator that accesses data asynchronously.

Field Summary

Fields

Modifier and Type	Field	Description
final OperatorInfo	info

Fields inherited from class org.apache.opendal.NativeObject

nativeHandle

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	append(String path, byte[] content)
CompletableFuture<Void>	append(String path, String content)
BlockingOperator	blocking()
CompletableFuture<Void>	copy(String sourcePath, String targetPath)
CompletableFuture<Void>	createDir(String path)
CompletableFuture<Void>	delete(String path)
protected void	disposeInternal(long handle)	Deletes underlying native object pointer.
Operator	duplicate()	Clone a new operator that is identical to this one.
Operator	layer(Layer layer)
CompletableFuture<List<Entry>>	list(String path)
static Operator	of(String schema, Map<String,String> map)	Construct an OpenDAL operator:
static Operator	of(String schema, Map<String,String> map, AsyncExecutor executor)	Construct an OpenDAL operator:
CompletableFuture<PresignedRequest>	presignRead(String path, Duration duration)
CompletableFuture<PresignedRequest>	presignStat(String path, Duration duration)
CompletableFuture<PresignedRequest>	presignWrite(String path, Duration duration)
CompletableFuture<byte[]>	read(String path)
CompletableFuture<Void>	removeAll(String path)
CompletableFuture<Void>	rename(String sourcePath, String targetPath)
CompletableFuture<Metadata>	stat(String path)
CompletableFuture<Void>	write(String path, byte[] content)
CompletableFuture<Void>	write(String path, String content)

Methods inherited from class org.apache.opendal.NativeObject

close, isDisposed

Methods inherited from class java.lang.Object

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

Field Details

info

public final OperatorInfo info

Method Details

of

public static Operator of(String schema,
 Map<String,String> map)

Construct an OpenDAL operator:

You can find all possible schemes here and see what config options each service supports.

Parameters:

schema - the name of the underneath service to access data from.

map - a map of properties to construct the underneath operator.

of

public static Operator of(String schema,
 Map<String,String> map,
 AsyncExecutor executor)

Construct an OpenDAL operator:

You can find all possible schemes here and see what config options each service supports.

Parameters:

schema - the name of the underneath service to access data from.

map - a map of properties to construct the underneath operator.

executor - the underneath executor to run async operations; null to use a default global executor.

duplicate

public Operator duplicate()

Clone a new operator that is identical to this one. The new operator has its own lifecycle.

Since an operator will release all its resource and "flush" on lifecycle end, this method is suitable to create a narrowed "scope" while avoiding creating a brand-new operator for each scope.

Returns:

the cloned operator.

layer

public Operator layer(Layer layer)

blocking

public BlockingOperator blocking()

write

public CompletableFuture<Void> write(String path,
 String content)

write

public CompletableFuture<Void> write(String path,
 byte[] content)

append

public CompletableFuture<Void> append(String path,
 String content)

append

public CompletableFuture<Void> append(String path,
 byte[] content)

stat

public CompletableFuture<Metadata> stat(String path)

read

public CompletableFuture<byte[]> read(String path)

presignRead

public CompletableFuture<PresignedRequest> presignRead(String path,
 Duration duration)

presignWrite

public CompletableFuture<PresignedRequest> presignWrite(String path,
 Duration duration)

presignStat

public CompletableFuture<PresignedRequest> presignStat(String path,
 Duration duration)

delete

public CompletableFuture<Void> delete(String path)

createDir

public CompletableFuture<Void> createDir(String path)

copy

public CompletableFuture<Void> copy(String sourcePath,
 String targetPath)

rename

public CompletableFuture<Void> rename(String sourcePath,
 String targetPath)

removeAll

public CompletableFuture<Void> removeAll(String path)

list

public CompletableFuture<List<Entry>> list(String path)

disposeInternal

protected void disposeInternal(long handle)

Description copied from class: NativeObject

Deletes underlying native object pointer.

Specified by:

disposeInternal in class NativeObject

Parameters:

handle - to the native object pointer