aistore.sdk.enums

View as MarkdownOpen in Claude

Module Contents

Classes

NameDescription
ColocationColocation hint for Batch (GetBatch) API optimization.
FLTPresenceAn enum representing the existence/lack thereof of buckets and objects in the AIS cluster.
LogSeverityLog severity levels for AIStore daemon logs.
NodeFilterFilter for selecting cluster nodes by type.

API

class aistore.sdk.enums.Colocation

Bases: enum.Enum

Colocation hint for Batch (GetBatch) API optimization.

See api/apc/ml.go for Go equivalent (ColocLevel).

NONE - no optimization; suitable for uniformly distributed data lakes where objects are spread evenly across all targets TARGET_AWARE - indicates that objects in this batch are collocated on few targets; proxy will compute HRW distribution and select the optimal distributed target (DT) to minimize cross-cluster data movement TARGET_AND_SHARD_AWARE - implies TARGET_AWARE, plus indicates that archpaths are collocated in few shards; enables additional optimization for archive handle reuse

E.g., use TARGET_AWARE or TARGET_AND_SHARD_AWARE when input TARs were constructed to match requested batches.

NONE
= 0
TARGET_AND_SHARD_AWARE
= 2
TARGET_AWARE
= 1
class aistore.sdk.enums.FLTPresence

Bases: enum.Enum

An enum representing the existence/lack thereof of buckets and objects in the AIS cluster.

FLT_EXISTS - object or bucket exists inside and/or outside cluster FLT_EXISTS_NO_PROPS - same as FLT_EXISTS but no need to return summary FLT_PRESENT - bucket is present or object is present and properly located FLT_PRESENT_NO_PROPS - same as FLT_PRESENT but no need to return summary FLT_PRESENT_CLUSTER - objects present anywhere/how in the cluster as replica, ec-slices, misplaced FLT_EXISTS_OUTSIDE - not present; exists outside cluster

FLT_EXISTS
= 0
FLT_EXISTS_NO_PROPS
= 1
FLT_EXISTS_OUTSIDE
= 5
FLT_PRESENT
= 2
FLT_PRESENT_CLUSTER
= 4
FLT_PRESENT_NO_PROPS
= 3
class aistore.sdk.enums.LogSeverity

Bases: enum.Enum

Log severity levels for AIStore daemon logs.

ERROR
= 'error'
INFO
= 'info'
WARNING
= 'warning'
class aistore.sdk.enums.NodeFilter

Bases: enum.Enum

Filter for selecting cluster nodes by type.

ALL
= 'all'
PROXY
= 'proxy'
TARGET
= 'target'