Package org.apache.opendal

Class Capability

java.lang.Object

org.apache.opendal.Capability

public class Capability
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final boolean	batch	If operator supports batch.
final boolean	batchDelete	If operator supports batch delete.
final long	batchMaxOperations	The max operations that operator supports in batch.
final boolean	blocking	If operator supports blocking.
final boolean	copy	If operator supports copy.
final boolean	createDir	If operator supports create dir.
final boolean	delete	If operator supports delete.
final boolean	list	If operator supports list.
final boolean	listWithLimit	If backend supports list with limit.
final boolean	listWithRecursive	If backend support list with recursive.
final boolean	listWithStartAfter	If backend supports list with start after.
final boolean	presign	If operator supports presign.
final boolean	presignRead	If operator supports presign read.
final boolean	presignStat	If operator supports presign stat.
final boolean	presignWrite	If operator supports presign write.
final boolean	read	If operator supports read.
final boolean	readWithIfMatch	If operator supports read with if matched.
final boolean	readWithIfNoneMatch	If operator supports read with if none match.
final boolean	readWithOverrideCacheControl	If operator supports read with override cache control.
final boolean	readWithOverrideContentDisposition	if operator supports read with override content disposition.
final boolean	readWithOverrideContentType	if operator supports read with override content type.
final boolean	rename	If operator supports rename.
final boolean	stat	If operator supports stat.
final boolean	statWithIfMatch	If operator supports stat with if matched.
final boolean	statWithIfNoneMatch	If operator supports stat with if none match.
final boolean	write	If operator supports write.
final boolean	writeCanAppend	If operator supports write by append.
final boolean	writeCanMulti	If operator supports write can be called in multi times.
final long	writeMultiAlignSize	write_multi_align_size is the align size that services required in write_multi.
final long	writeMultiMaxSize	write_multi_max_size is the max size that services support in write_multi.
final long	writeMultiMinSize	write_multi_min_size is the min size that services support in write_multi.
final boolean	writeWithCacheControl	If operator supports write with cache control.
final boolean	writeWithContentDisposition	If operator supports write with content disposition.
final boolean	writeWithContentType	If operator supports write with content type.

Constructor Summary

Constructors

Constructor

Description

Capability(boolean stat, boolean statWithIfMatch, boolean statWithIfNoneMatch, boolean read, boolean readWithIfMatch, boolean readWithIfNoneMatch, boolean readWithOverrideCacheControl, boolean readWithOverrideContentDisposition, boolean readWithOverrideContentType, boolean write, boolean writeCanMulti, boolean writeCanAppend, boolean writeWithContentType, boolean writeWithContentDisposition, boolean writeWithCacheControl, long writeMultiMaxSize, long writeMultiMinSize, long writeMultiAlignSize, boolean createDir, boolean delete, boolean copy, boolean rename, boolean list, boolean listWithLimit, boolean listWithStartAfter, boolean listWithRecursive, boolean presign, boolean presignRead, boolean presignStat, boolean presignWrite, boolean batch, boolean batchDelete, long batchMaxOperations, boolean blocking)

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

stat

public final boolean stat

If operator supports stat.

statWithIfMatch

public final boolean statWithIfMatch

If operator supports stat with if matched.

statWithIfNoneMatch

public final boolean statWithIfNoneMatch

If operator supports stat with if none match.

read

public final boolean read

If operator supports read.

readWithIfMatch

public final boolean readWithIfMatch

If operator supports read with if matched.

readWithIfNoneMatch

public final boolean readWithIfNoneMatch

If operator supports read with if none match.

readWithOverrideCacheControl

public final boolean readWithOverrideCacheControl

If operator supports read with override cache control.

readWithOverrideContentDisposition

public final boolean readWithOverrideContentDisposition

if operator supports read with override content disposition.

readWithOverrideContentType

public final boolean readWithOverrideContentType

if operator supports read with override content type.

write

public final boolean write

If operator supports write.

writeCanMulti

public final boolean writeCanMulti

If operator supports write can be called in multi times.

writeCanAppend

public final boolean writeCanAppend

If operator supports write by append.

writeWithContentType

public final boolean writeWithContentType

If operator supports write with content type.

writeWithContentDisposition

public final boolean writeWithContentDisposition

If operator supports write with content disposition.

writeWithCacheControl

public final boolean writeWithCacheControl

If operator supports write with cache control.

writeMultiMaxSize

public final long writeMultiMaxSize

write_multi_max_size is the max size that services support in write_multi. For example, AWS S3 supports 5GiB as max in write_multi.

writeMultiMinSize

public final long writeMultiMinSize

write_multi_min_size is the min size that services support in write_multi. For example, AWS S3 requires at least 5MiB in write_multi expect the last one.

writeMultiAlignSize

public final long writeMultiAlignSize

write_multi_align_size is the align size that services required in write_multi. For example, Google GCS requires align size to 256KiB in write_multi.

createDir

public final boolean createDir

If operator supports create dir.

delete

public final boolean delete

If operator supports delete.

copy

public final boolean copy

If operator supports copy.

rename

public final boolean rename

If operator supports rename.

list

public final boolean list

If operator supports list.

listWithLimit

public final boolean listWithLimit

If backend supports list with limit.

listWithStartAfter

public final boolean listWithStartAfter

If backend supports list with start after.

listWithRecursive

public final boolean listWithRecursive

If backend support list with recursive.

presign

public final boolean presign

If operator supports presign.

presignRead

public final boolean presignRead

If operator supports presign read.

presignStat

public final boolean presignStat

If operator supports presign stat.

presignWrite

public final boolean presignWrite

If operator supports presign write.

batch

public final boolean batch

If operator supports batch.

batchDelete

public final boolean batchDelete

If operator supports batch delete.

batchMaxOperations

public final long batchMaxOperations

The max operations that operator supports in batch.

blocking

public final boolean blocking

If operator supports blocking.

Constructor Details

Capability

public Capability(boolean stat,
 boolean statWithIfMatch,
 boolean statWithIfNoneMatch,
 boolean read,
 boolean readWithIfMatch,
 boolean readWithIfNoneMatch,
 boolean readWithOverrideCacheControl,
 boolean readWithOverrideContentDisposition,
 boolean readWithOverrideContentType,
 boolean write,
 boolean writeCanMulti,
 boolean writeCanAppend,
 boolean writeWithContentType,
 boolean writeWithContentDisposition,
 boolean writeWithCacheControl,
 long writeMultiMaxSize,
 long writeMultiMinSize,
 long writeMultiAlignSize,
 boolean createDir,
 boolean delete,
 boolean copy,
 boolean rename,
 boolean list,
 boolean listWithLimit,
 boolean listWithStartAfter,
 boolean listWithRecursive,
 boolean presign,
 boolean presignRead,
 boolean presignStat,
 boolean presignWrite,
 boolean batch,
 boolean batchDelete,
 long batchMaxOperations,
 boolean blocking)