Struct Attribution 

#[non_exhaustive]
pub struct Attribution { /* private fields */ }

Caller-supplied labels attached to every request of a repository.

They are rendered into the User-Agent header so the bucket owner can break traffic down in access logs by three questions:

• client: which software is talking to the bucket. The product token of the application or library that embeds icechunk, e.g. weatherlib/0.9.
• workload: what it is doing. The job, pipeline or deployment that runs the requests, e.g. nightly-ingest or dashboard-v2.
• principal: on whose behalf. A user id, service account or tenant, set by services that act for many users.

The array path and chunk coordinates are added per request by icechunk itself and need no configuration.

Implementations

impl Attribution

pub fn new() -> Self

pub fn with_client( self, client: impl Into<String>, ) -> Result<Self, AttributionError>

Which software is talking to the bucket: the product token of the application or library that embeds icechunk, name or name/version in HTTP token characters, e.g. weatherlib/0.9.

pub fn with_workload( self, workload: impl Into<String>, ) -> Result<Self, AttributionError>

What the requests are for: the job, pipeline or deployment running them, e.g. nightly-ingest. Printable ASCII, at most 128 bytes, none of (, ), \, ;, =, ".

pub fn with_principal( self, principal: impl Into<String>, ) -> Result<Self, AttributionError>

On whose behalf the requests are made: a user id, service account or tenant, for services that act for many users. Same rules as Attribution::with_workload.

pub fn client(&self) -> Option<&str>

pub fn workload(&self) -> Option<&str>

pub fn principal(&self) -> Option<&str>

Trait Implementations

impl Clone for Attribution

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Attribution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Attribution

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Attribution

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Attribution

impl From<&Attribution> for AttributionLabels

fn from(a: &Attribution) -> Self

Converts to this type from the input type.

impl PartialEq for Attribution

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Attribution

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Attribution