Skip to main content

Module v1

Module v1 

Source

Modules§

accounting_service_client
Generated client implementations.
accounting_service_server
Generated server implementations.
administration_service_client
Generated client implementations.
administration_service_server
Generated server implementations.
application_role_request
Nested message and enum types in ApplicationRoleRequest.
authz_consistency
Nested message and enum types in AuthzConsistency.
authz_service_client
Generated client implementations.
authz_service_server
Generated server implementations.
batch_get_outcome
Nested message and enum types in BatchGetOutcome.
bulk_operation
Nested message and enum types in BulkOperation.
bulk_outcome
Nested message and enum types in BulkOutcome.
credential_service_client
Generated client implementations.
credential_service_server
Generated server implementations.
index_query
Nested message and enum types in IndexQuery.
index_service_client
Generated client implementations.
index_service_server
Generated server implementations.
index_specification
Nested message and enum types in IndexSpecification.
object_chunk
Nested message and enum types in ObjectChunk.
object_filter
Nested message and enum types in ObjectFilter.
object_head
Nested message and enum types in ObjectHead.
object_ref
Nested message and enum types in ObjectRef.
object_service_client
Generated client implementations.
object_service_server
Generated server implementations.
object_version
Nested message and enum types in ObjectVersion.
permission_rule
Nested message and enum types in PermissionRule.
personal_db_service_client
Generated client implementations.
personal_db_service_server
Generated server implementations.
put_header
Nested message and enum types in PutHeader.
relation_definition
Nested message and enum types in RelationDefinition.
subject
Nested message and enum types in Subject.
subject_selector
Nested message and enum types in SubjectSelector.
tuple_mutation
Nested message and enum types in TupleMutation.
watch_message
Nested message and enum types in WatchMessage.
watch_prefix_request
Nested message and enum types in WatchPrefixRequest.

Structs§

AccessToken
AccountingDefinition
AccountingFreshness
AccountingSnapshot
AccountingSourceCheckpoint
AnyObjectSelector
AnyUsersetSelector
AppendPersonalDbEntryRequest
ApplicationCredential
ApplicationCredentialState
ApplicationRoleRequest
ApplicationRoleResponse
AtLeastRevision
AuthzConsistency
AuthzScope
The structural boundary for an authorization graph. default is the conventional application realm. _anvil/system is deliberately representable here because Anvil uses the same data model internally; public calls targeting that reserved scope are rejected by the server. For every public call, storage_tenant must equal the authenticated caller’s immutable storage tenant; spelling another tenant never changes identity.
BatchGetObject
BatchGetOutcome
BatchGetRequest
Batch reads are independent and bounded by server item and byte limits.
BatchGetResponse
BindSchemaRequest
BindSchemaResponse
BucketApplicationRoleTarget
BucketPolicy
Prefixes are bucket-relative. Anything below an immutable prefix is write-once; anything below a program-only prefix is writable only through a pinned atomic program. Overlap validation belongs to the server.
BulkOperation
BulkOutcome
BulkPutIfVersionRequest
BulkPutRequest
Bulk puts carry their bounded payload inline because there is one enclosing unary request. They use the same canonical operation identity and semantics as the corresponding StartPut plus Put plus PutEnd sequence.
BulkWriteRequest
Bulk operations are independent. The server enforces finite item and byte limits; one failed operation does not roll back another successful one.
BulkWriteResponse
ChangePersonalDbGroupRoleRequest
CheckPermissionRequest
CheckPermissionResponse
CheckPermissionsRequest
At most 1000 checks. The server pins one authoritative snapshot, so every result is evaluated at the single returned revision and retains input order.
CheckPermissionsResponse
CreateApplicationRequest
Application IDs and client IDs are cluster-wide authentication identities; each is globally unique. An application has exactly one client credential in Anvil 0.5. Supplying the same canonical application, client ID and secret is an idempotent replay.
CreateBucketRequest
A bucket’s durable existence marker and first system-realm owner tuple are written in one metadata batch. The caller becomes that owner.
CreateBucketResponse
CreateIndexRequest
CreatePersonalDbGroupRequest
DeleteIfVersionRequest
DeleteIndexRequest
DeleteIndexResponse
DeleteRequest
DeleteVersionRequest
DeleteVersionResponse
DeletedObject
DescribePersonalDbGroupRequest
DirectRelation
Direct relations are the only schema members that accept tuples.
DisableAccountingRequest
DisableAccountingResponse
DisableApplicationCredentialRequest
Stops future exchanges. Access tokens already issued to this application remain valid until their stated expiry.
EnableAccountingRequest
ExactRevision
ExchangeClientCredentialsRequest
FullTextField
FullTextIndexQuery
FullTextIndexSpec
GetAccountingRequest
GetBindingRequest
GetBindingResponse
GetIndexRequest
GetObjectRequest
GetPersonalDbSnapshotRequest
GetSchemaRequest
Schema lookup is exact: callers obtain a complete immutable reference from PutSchema or GetBinding rather than asking for an implicit latest revision.
GetSchemaResponse
GitSourceIndexQuery
GitSourceIndexSpec
HeadObjectRequest
HybridIndexQuery
HybridIndexSpec
IndexDefinition
Index names are immutable bucket-local identifiers. Mutable display labels belong in application data. Placement uses the server-allocated index_id.
IndexField
IndexFreshness
Freshness is evidence, not an admission rule. A query returns the available generation and this structure; it never fails solely because indexing lags.
IndexOrder
IndexPredicate
IndexQuery
IndexQueryHit
IndexSourceFreshness
IndexSpecification
InheritRule
InvokeProgramRequest
This is the only public operation in this service with atomic multi-path visibility. A program definition is an ordinary immutable object at the bucket-relative path _anvil/programs/{name}@{version}. It is written through StartPut with PutImmutableOperation, followed by Put and PutEnd, and is governed by the same path authorization as every other object. The invocation pins that ordinary object’s full address and content hash.
InvokeProgramResponse
LatestConsistency
ListIndexesRequest
ListIndexesResponse
ListObjectVersionsRequest
ListObjectsRequest
ListObjectsResponse
ListPersonalDbGroupsRequest
ListPersonalDbGroupsResponse
MaterializePersonalDbProjectionRequest
MetadataFilterIndexQuery
MetadataFilterIndexSpec
MutateTuplesRequest
The non-empty batch is one all-or-nothing set mutation in one realm. Add and remove are idempotent. The 0.5 hard limit is 1000 mutations and the operation ID is limited to 128 UTF-8 bytes. Reusing an operation ID with a different canonical input is rejected.
MutateTuplesResponse
MutationFailure
MutationReceipt
NamespaceDefinition
NeverExisted
ObjectAddress
ObjectChunk
A GetObject stream begins with exactly one head. Bytes follow only for a PresentObject state.
ObjectFilter
Object filters select either one namespace or one exact typed object.
ObjectHead
Exact path state. A tombstone has a version and is not the same as a path for which no version has ever existed.
ObjectRef
Identifiers, namespaces, relations, schema IDs, and realm IDs are limited to 256 UTF-8 bytes. Opaque object IDs and exact paths are limited to 4096 UTF-8 bytes. A realm is carried only by AuthzScope, never in a namespace.
ObjectVersion
Retained metadata for one live value or tombstone. NeverExisted is not a version and therefore cannot occur in this stream.
PathIndexQuery
PathIndexSpec
Permission
A permission is a bounded union of its rules and cannot accept tuples.
PermissionCheck
PermissionResult
PermissionRule
PersonalDbCanonicalFrame
PersonalDbCatchUpRequest
PersonalDbCommit
PersonalDbGroup
PersonalDbGroupRoleChange
PersonalDbMaterialization
PersonalDbMirrorProjectionDefinition
PersonalDbSnapshot
PrepareNodeRequest
PrepareNodeResponse
PresentObject
ProgramPathReceipt
ProvisionTenantRequest
Creates one storage tenant, its first owner application and that application’s credential in one durable metadata write. Only a caller with system#manage_system may perform this operation.
ProvisionTenantResponse
PublicSubjectSelector
PutHeader
Complete metadata and operation for one addressed upload. A header never contains payload bytes, a caller-supplied content hash, or a storage reference. Exactly one operation must be selected.
PutIfAbsentOperation
Create on a MUTABLE path only when no live value exists.
PutIfVersionOperation
Publish on a MUTABLE path only when its current live or tombstone head has exactly expected_version. The condition is checked when the completed upload is published; StartPut does not reserve or lock the path while bytes arrive.
PutImmutableOperation
Create on an IMMUTABLE path. Identical existing content is an idempotent replay; different existing content fails. This operation never changes path policy.
PutOperation
Unconditional ordinary put: publish the next version of a MUTABLE path.
PutRequest
Protobuf cannot make a field unskippable on a hostile wire, so the server rejects a missing/empty token. Unlike the old frame union, however, this message has no header variant a normal client can send out of order. Every request in one stream must carry the same token.
PutSchemaRequest
A 0.5 schema contains at most 256 namespaces, 256 members per namespace, and 256 selectors or rules per member. Publication canonicalizes the body: replaying identical content returns the same SchemaRef, while changed content creates the next immutable revision for the schema ID.
PutSchemaResponse
PutToken
Opaque upload capability returned by StartPut. Clients must not parse value. A token is bound to its authenticated caller and one protocol phase. StartPut returns an UPLOAD token; Put returns a fresh READY token for PutEnd.
QueryIndexRequest
QueryIndexResponse
ReadFailure
ReadTuplesRequest
An absent consistency value means latest. page_size zero selects the server default of 100; the 0.5 hard maximum is 1000. page_token is opaque and limited to 128 KiB. A returned token pins its continuation to the same filters and revision; a no-longer-current revision fails rather than moving.
ReadTuplesResponse
RegisterPersonalDbSnapshotRequest
RelationDefinition
RelationTuple
RotateApplicationCredentialRequest
SameResourceIdSelector
SchemaBinding
SchemaRef
A canonical immutable schema identity. The server assigns the revision and digest; clients never publish either as metadata.
SetBucketPolicyRequest
SetBucketPublicReadRequest
SetBucketPublicReadResponse
SetBucketVersioningRequest
Only ENABLED is accepted. UNVERSIONED is selected at CreateBucket time by omission/default and cannot be restored after versioning has been enabled.
SetBucketVersioningResponse
Subject
A tuple subject is either one typed object or one userset in the request’s realm. The reserved public principal is the object app:_anvil/public; schemas must still opt into it with PublicSubjectSelector.
SubjectSelector
SystemApplicationRoleTarget
TenantApplicationRoleTarget
TensorIndexQuery
TensorIndexSpec
One exact model tensor-name projection. The definition fixes the model; queries select one tensor within it.
TupleFilter
Omitted fields are wildcards. Supplying an exact Subject matches that typed object or userset only.
TupleMutation
TupleToUsersetRule
TypedJsonIndexQuery
TypedJsonIndexSpec
UpdateIndexRequest
Userset
VectorIndexQuery
VectorIndexSpec
WatchCheckpoint
Persist this opaque token only after every preceding invalidation has been durably applied. Reconnecting from it may legally redeliver invalidations.
WatchInvalidation
WatchMessage
WatchNow
WatchPrefixRequest
WatchPrefix is an unordered, at-least-once invalidation feed. Duplicates are legal and rapid changes to one path may be coalesced; intermediate versions are not promised. It carries no payload bytes and is not change-data-capture or an audit log. A consumer must reread each path until it observes at least minimum_path_version.
WatchRetainedBeginning

Enums§

BucketApplicationRole
Durability
LOCAL is the default for speed: the ingress acknowledges after its durable local write while normal placement continues. REPLICATED waits for the fixed 2+1 payload layout (or the corresponding mutable-record quorum) before acknowledging. A cluster that cannot satisfy the requested class returns DURABILITY_UNAVAILABLE without publishing. Unknown values are invalid.
IndexKind
IndexOrderDirection
IndexPredicateOperator
MutationFailureCode
ObjectVersioning
UNVERSIONED is the meaningful zero/default: replacing or deleting a head does not retain the predecessor for later reads. ENABLED retains versions and is a one-way bucket capability.
PersonalDbGroupKind
PersonalDbGroupRole
ReadFailureCode
SystemApplicationRole
TenantApplicationRole
VectorMetric
WatchStateHint