Module objects 

Generated transport-independent contract objects.

Structs

ArborScanUsage

Counters of one execution of an Arbor Table scan, as the executor reported them. Fragments and files are Arbor concepts, so a scan of another table format takes its own arm. resourceId and versionId of the record name the Table version that was read. An execution that ended before its last row (finished false) counts only the splits that it read to their end.

ProjectId

Identifier of the project whose usage a request reports.

ReportUsageRecordsRequest

At most 1,000 records of one project. The service drops and counts a record that occurred more than 30 days before it receives the request, or more than five minutes after.

ReportUsageRequest

Events scoped to exactly one legacy table or project. The service rejects requests that provide both scope identifiers or neither identifier.

StorageReads

Successful object reads of one scan execution. scope says which of the scan’s reads the counters include.

UsageEvent

One schema-agnostic metering event. The server overwrites project_id and org_id with authoritative values before delivery.

UsageRecord

One raw measurement of work that a host ran for a project, such as one Table scan. A record states what happened and never carries a price. The host sets id once and keeps it when it sends the record again. occurredAtMicros is when the work ended, in microseconds since the Unix epoch. source names the host software, for example rust-sdk, and emitterVersion its version. The service adds the organization, the caller and the time it received the record.

Enums

StorageReadScope

Whether the storage counters include every read of the scan or only some. A scan reads storage in two ways. It reads some objects itself. It reads payload files through a file reader that all scans in the process share, and that reader does not know which scan asked for which bytes. complete means the counters include both, so bytes is everything the scan read. direct means the counters include only the reads that the scan made itself. Reads through the shared reader are missing, so the counters are a lower bound. Do not add direct counters to complete counters.

UsageError

Typed errors declared by this service contract.

UsageMeasurement

What a record measured. The arm name is the versioned schema of the measurement. A change in meaning takes a new arm, such as arborScanV2, and never changes an existing one. A server rejects an arm that it does not know, so a server that accepts a new arm deploys before a host that sends it.