Module spicedb

Module spicedb 

Source

Modules§

algebraic_subject_set
Nested message and enum types in AlgebraicSubjectSet.
bulk_check_permission_pair
Nested message and enum types in BulkCheckPermissionPair.
caveat_eval_info
Nested message and enum types in CaveatEvalInfo.
check_bulk_permissions_pair
Nested message and enum types in CheckBulkPermissionsPair.
check_debug_trace
Nested message and enum types in CheckDebugTrace.
check_permission_response
Nested message and enum types in CheckPermissionResponse.
consistency
Nested message and enum types in Consistency.
delete_relationships_response
Nested message and enum types in DeleteRelationshipsResponse.
exp_schema_diff
Nested message and enum types in ExpSchemaDiff.
exp_type_reference
Nested message and enum types in ExpTypeReference.
experimental_count_relationships_response
Nested message and enum types in ExperimentalCountRelationshipsResponse.
experimental_service_client
Generated client implementations.
lookup_subjects_request
Nested message and enum types in LookupSubjectsRequest.
permission_relationship_tree
Nested message and enum types in PermissionRelationshipTree.
permissions_service_client
Generated client implementations.
precondition
Nested message and enum types in Precondition.
relationship_update
Nested message and enum types in RelationshipUpdate.
schema_service_client
Generated client implementations.
subject_filter
Nested message and enum types in SubjectFilter.
watch_service_client
Generated client implementations.
wrappers

Structs§

AlgebraicSubjectSet
AlgebraicSubjectSet is a subject set which is computed based on applying the specified operation to the operands according to the algebra of sets.
BulkCheckPermissionPair
BulkCheckPermissionRequest
NOTE: Deprecated now that BulkCheckPermission has been promoted to the stable API as “CheckBulkPermission”.
BulkCheckPermissionRequestItem
BulkCheckPermissionResponse
BulkCheckPermissionResponseItem
BulkExportRelationshipsRequest
BulkExportRelationshipsRequest represents a resumable request for all relationships from the server.
BulkExportRelationshipsResponse
BulkExportRelationshipsResponse is one page in a stream of relationship groups that meet the criteria specified by the originating request. The server will continue to stream back relationship groups as quickly as it can until all relationships have been transmitted back.
BulkImportRelationshipsRequest
BulkImportRelationshipsRequest represents one batch of the streaming BulkImportRelationships API. The maximum size is only limited by the backing datastore, and optimal size should be determined by the calling client experimentally.
BulkImportRelationshipsResponse
BulkImportRelationshipsResponse is returned on successful completion of the bulk load stream, and contains the total number of relationships loaded.
CaveatEvalInfo
CaveatEvalInfo holds information about a caveat expression that was evaluated.
CheckBulkPermissionsPair
CheckBulkPermissionsRequest
CheckBulkPermissionsRequest issues a check on whether a subject has permission or is a member of a relation on a specific resource for each item in the list.
CheckBulkPermissionsRequestItem
CheckBulkPermissionsResponse
CheckBulkPermissionsResponseItem
CheckDebugTrace
CheckDebugTrace is a recursive trace of the requests made for resolving a CheckPermission API call.
CheckPermissionRequest
CheckPermissionRequest issues a check on whether a subject has a permission or is a member of a relation, on a specific resource.
CheckPermissionResponse
Consistency
Consistency will define how a request is handled by the backend. By defining a consistency requirement, and a token at which those requirements should be applied, where applicable.
ContextualizedCaveat
ContextualizedCaveat represents a reference to a caveat to be used by caveated relationships. The context consists of key-value pairs that will be injected at evaluation time. The keys must match the arguments defined on the caveat in the schema.
Cursor
Cursor is used to provide resumption of listing between calls to APIs such as LookupResources.
DebugInformation
DebugInformation defines debug information returned by an API call in a footer when requested with a specific debugging header.
DeleteRelationshipsRequest
DeleteRelationshipsRequest specifies which Relationships should be deleted, requesting the delete of ALL relationships that match the specified filters. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the delete will be executed.
DeleteRelationshipsResponse
DirectSubjectSet
DirectSubjectSet is a subject set which is simply a collection of subjects.
ExpCaveat
ExpCaveat is the representation of a caveat in the schema.
ExpCaveatParameter
ExpCaveatParameter is the representation of a parameter in a caveat.
ExpCaveatParameterTypeChange
ExpDefinition
ExpDefinition is the representation of a definition in the schema.
ExpPermission
ExpPermission is the representation of a permission in the schema.
ExpRelation
ExpRelation is the representation of a relation in the schema.
ExpRelationReference
ExpRelationReference is a reference to a relation or permission in the schema.
ExpRelationSubjectTypeChange
ExpSchemaDiff
ExpSchemaDiff is the representation of a diff between two schemas.
ExpSchemaFilter
ExpSchemaFilter is a filter that can be applied to the schema on reflection.
ExpTypeReference
ExpTypeReference is the representation of a type reference in the schema.
ExpandPermissionTreeRequest
ExpandPermissionTreeRequest returns a tree representing the expansion of all relationships found accessible from a permission or relation on a particular resource.
ExpandPermissionTreeResponse
ExperimentalComputablePermissionsRequest
ExperimentalComputablePermissionsResponse
ExperimentalCountRelationshipsRequest
ExperimentalCountRelationshipsResponse
ExperimentalDependentRelationsRequest
ExperimentalDependentRelationsResponse
ExperimentalDiffSchemaRequest
ExperimentalDiffSchemaResponse
ExperimentalReflectSchemaRequest
ExperimentalReflectSchemaResponse
ExperimentalRegisterRelationshipCounterRequest
ExperimentalRegisterRelationshipCounterResponse
ExperimentalUnregisterRelationshipCounterRequest
ExperimentalUnregisterRelationshipCounterResponse
LookupResourcesRequest
LookupResourcesRequest performs a lookup of all resources of a particular kind on which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those resources.
LookupResourcesResponse
LookupResourcesResponse contains a single matching resource object ID for the requested object type, permission, and subject.
LookupSubjectsRequest
LookupSubjectsRequest performs a lookup of all subjects of a particular kind for which the subject has the specified permission or the relation in which the subject exists, streaming back the IDs of those subjects.
LookupSubjectsResponse
LookupSubjectsResponse contains a single matching subject object ID for the requested subject object type on the permission or relation.
ObjectReference
ObjectReference is used to refer to a specific object in the system.
PartialCaveatInfo
PartialCaveatInfo carries information necessary for the client to take action in the event a response contains a partially evaluated caveat
PermissionRelationshipTree
PermissionRelationshipTree is used for representing a tree of a resource and its permission relationships with other objects.
Precondition
Precondition specifies how and the existence or absence of certain relationships as expressed through the accompanying filter should affect whether or not the operation proceeds.
ReadCounterValue
ReadRelationshipsRequest
ReadRelationshipsRequest specifies one or more filters used to read matching relationships within the system.
ReadRelationshipsResponse
ReadRelationshipsResponse contains a Relationship found that matches the specified relationship filter(s). A instance of this response message will be streamed to the client for each relationship found.
ReadSchemaRequest
ReadSchemaRequest returns the schema from the database.
ReadSchemaResponse
ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.
Relationship
Relationship specifies how a resource relates to a subject. Relationships form the data for the graph over which all permissions questions are answered.
RelationshipFilter
RelationshipFilter is a collection of filters which when applied to a relationship will return relationships that have exactly matching fields.
RelationshipUpdate
RelationshipUpdate is used for mutating a single relationship within the service.
ResolvedSubject
ResolvedSubject is a single subject resolved within LookupSubjects.
SubjectFilter
SubjectFilter specifies a filter on the subject of a relationship.
SubjectReference
SubjectReference is used for referring to the subject portion of a Relationship. The relation component is optional and is used for defining a sub-relation on the subject, e.g. group:123#members
WatchRequest
WatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.
WatchResponse
WatchResponse contains all tuple modification events in ascending timestamp order, from the requested start snapshot to a snapshot encoded in the watch response. The client can use the snapshot to resume watching where the previous watch response left off.
WriteRelationshipsRequest
WriteRelationshipsRequest contains a list of Relationship mutations that should be applied to the service. If the optional_preconditions parameter is included, all of the specified preconditions must also be satisfied before the write will be committed.
WriteRelationshipsResponse
WriteSchemaRequest
WriteSchemaRequest is the required data used to “upsert” the Schema of a Permissions System.
WriteSchemaResponse
WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.
ZedToken
ZedToken is used to provide causality metadata between Write and Check requests.

Enums§

LookupPermissionship
LookupPermissionship represents whether a Lookup response was partially evaluated or not

Functions§

caveated_relationship_update
object_reference
precondition
precondition_raw
relationship_filter
relationship_filter_raw
relationship_update
subject_filter
subject_filter_raw
subject_reference
subject_reference_raw
wildcard_relationship_update