Package apc: API control messages and constants * Copyright (c) 2018-2024, NVIDIA CORPORATION.

Package authn provides AuthN API over HTTP(S) * Copyright (c) 2018-2025, NVIDIA CORPORATION.

Package env contains environment variables * Copyright (c) 2024-2025, NVIDIA CORPORATION.

a.k.a.

Archive multiple objects from the specified source bucket.

CopyBucket copies existing `bckFrom` bucket to the destination `bckTo` thus, effectively, creating a copy of the `bckFrom`.

CreateBucket sends request to create an AIS bucket with the given name and, optionally, specific non-default properties (via cmn.BpropsToSet).

DecommissionCluster permanently decommissions entire cluster.

DestroyBucket sends request to remove an AIS bucket with the given name.

Erasure-code entire `bck` bucket at a given `data`:`parity` redundancy.

Transform src bucket => dst bucket, i.e.: - visit all (matching) source objects; for each object: - read it, transform using the specified (ID-ed) ETL, and write the result to dst bucket `fltPresence` applies exclusively to remote `bckFrom` (is ignored otherwise) and is one of: { apc.FltExists, apc.FltPresent, ..

Initiate custom ETL workload by executing one of the documented `etl.InitMsg` message types.

EvictRemoteBucket sends request to evict an entire remote bucket from the AIStore - keepMD: evict objects but keep bucket metadata.

FlushObject must be called after all the appends (via `api.AppendObject`).

returns a slice of canonical xaction names, as in: `xact.Cname()` e.g.: put-copies[D-ViE6HEL_j] list[H96Y7bhR2s] copy-bck[matRQMRes] put-copies[pOibtHExY] TODO: return idle xactions separately.

same as above, except that it returns _all_ matching xactions.

get bucket metadata (BMD) from a BaseParams-referenced node.

Bucket information - a runtime addendum to `BucketProps`.

GetBucketSummary returns bucket capacity ulitization percentages, sizes (total and min/max/average), and the numbers of objects, both _in_ the cluster and remote GetBucketSummary supports a single specified bucket or multiple buckets, as per `cmn.QueryBcks` query.

GetClusterConfig returns cluster-wide configuration (compare with `api.GetDaemonConfig`).

get cluster map from a BaseParams-referenced node.

GetClusterSysInfo retrieves cluster's system information.

(see also enable/disable backend below).

GetDaemonConfig returns the configuration of a specific daemon in a cluster.

Returns log of a specific node in a cluster.

NOTE: direct call used only in tests (remove?).

names _and_ kinds, i.e.

GetMountpaths given the direct public URL of the target, returns the target's mountpaths or error.

GetNodeClusterMap retrieves cluster map from the specified node.

- get (smap, bmd, config) *cluster-level* metadata from the spec-ed node - compare with GetClusterMap, GetNodeClusterMap, GetClusterConfig et al.

Returns reader of the requested object.

s3/<bucket-name>/<object-name>.

Same as above with checksum validation.

GetOneXactionStatus queries one of the IC (proxy) members for status of the `args`-identified xaction.

to be used by external watchdogs (Kubernetes, etc.) (compare with api.Health below).

returns both node's stats (as above) and extended status.

HEAD(bucket): apc.HdrBucketProps => cmn.Bprops{} and apc.HdrBucketInfo => BucketInfo{} Converts the string type fields returned from the HEAD request to their corresponding counterparts in the cmn.Bprops struct.

HTTPStatus returns HTTP status or (-1) for non-HTTP error.

JoinCluster add a node to a cluster.

ListBuckets returns buckets for provided query, where - `fltPresence` is one of { apc.FltExists, apc.FltPresent, ..

ListObjects returns a list of objects in a bucket - a slice of structures in the `cmn.LsoRes` that look like `cmn.LsoEnt`.

ListObjectsPage returns the first page of bucket objects.

MakeNCopies starts an extended action (xaction) to bring a given bucket to a certain redundancy level (num copies).

QueryBuckets is a little convenience helper.

QueryXactionSnaps gets all xaction snaps based on the specified selection.

Remove node node from the cluster immediately.

RenameBucket renames bckFrom as bckTo.

ResetBucketProps resets the properties of a bucket to the global configuration.

all nodes: reset configuration to cluster defaults.

reset node's configuration to cluster defaults.

SetBucketProps sets the properties of a bucket.

SetClusterConfig given key-value pairs of cluster configuration parameters, sets the cluster-wide configuration accordingly.

SetClusterConfigUsingMsg sets the cluster-wide configuration using the `cmn.ConfigToSet` parameter provided.

SetDaemonConfig, given key value pairs, sets the configuration accordingly for a specific node.

SetPrimaryProxy given a daemonID sets that corresponding proxy as the primary proxy of the cluster.

ShutdownCluster shuts down the whole cluster.

ShutdownNode shuts down a specific node.

WaitForXactionIC waits for a given xaction to complete.

WaitForXactionIdle waits for a given on-demand xaction to be idle.

WaitForXactionNode waits for a given xaction to complete.

APPEND, Archive, Promote (object).

APPEND, Archive, Promote (object).

GET(object).

HEAD(object).

GET(object).

APPEND, Archive, Promote (object).

PUT(object) - Cksum is optional; when provided: if object exists: load the object's metadata, compare checksums - skip writing if equal otherwise, compare the two checksums upon writing (aka, "end-to-end protection") - SkipVC: skip loading existing object's metadata in order to compare its Checksum and update its existing Version (if exists); can be used to reduce PUT latency when massively writing new content (or simply don't care).