Package com.authzed.api.v1

Class SchemaServiceGrpc.SchemaServiceStub

java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<SchemaServiceGrpc.SchemaServiceStub>
com.authzed.api.v1.SchemaServiceGrpc.SchemaServiceStub
Enclosing class:
SchemaServiceGrpc
public static final class SchemaServiceGrpc.SchemaServiceStub extends io.grpc.stub.AbstractAsyncStub<SchemaServiceGrpc.SchemaServiceStub>
A stub to allow clients to do asynchronous rpc calls to service SchemaService. 
 SchemaService implements operations on a Permissions System's Schema.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected SchemaServiceGrpc.SchemaServiceStub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    void
    computablePermissions(ComputablePermissionsRequest request, io.grpc.stub.StreamObserver<ComputablePermissionsResponse> responseObserver)
    ComputablePermissions returns the set of permissions that compute based off a relation in the current schema.
    void
    dependentRelations(DependentRelationsRequest request, io.grpc.stub.StreamObserver<DependentRelationsResponse> responseObserver)
    DependentRelations returns the set of relations and permissions that used to compute a permission, recursively, in the current schema.
    void
    diffSchema(DiffSchemaRequest request, io.grpc.stub.StreamObserver<DiffSchemaResponse> responseObserver)
    DiffSchema returns the difference between the specified schema and the current schema stored in SpiceDB.
    void
    readSchema(ReadSchemaRequest request, io.grpc.stub.StreamObserver<ReadSchemaResponse> responseObserver)
    Read returns the current Object Definitions for a Permissions System.
    void
    reflectSchema(ReflectSchemaRequest request, io.grpc.stub.StreamObserver<ReflectSchemaResponse> responseObserver)
    ReflectSchema reflects the current schema stored in SpiceDB, returning a structural form of the schema for use by client tooling.
    void
    writeSchema(WriteSchemaRequest request, io.grpc.stub.StreamObserver<WriteSchemaResponse> responseObserver)
    Write overwrites the current Object Definitions for a Permissions System.

    Methods inherited from class io.grpc.stub.AbstractAsyncStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

      protected SchemaServiceGrpc.SchemaServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<SchemaServiceGrpc.SchemaServiceStub>

    • readSchema

      public void readSchema(ReadSchemaRequest request, io.grpc.stub.StreamObserver<ReadSchemaResponse> responseObserver)
       Read returns the current Object Definitions for a Permissions System.
 Errors include:
 - INVALID_ARGUMENT: a provided value has failed to semantically validate
 - NOT_FOUND: no schema has been defined

    • writeSchema

      public void writeSchema(WriteSchemaRequest request, io.grpc.stub.StreamObserver<WriteSchemaResponse> responseObserver)
       Write overwrites the current Object Definitions for a Permissions System.

    • reflectSchema

      public void reflectSchema(ReflectSchemaRequest request, io.grpc.stub.StreamObserver<ReflectSchemaResponse> responseObserver)
       ReflectSchema reflects the current schema stored in SpiceDB, returning a structural
 form of the schema for use by client tooling.

    • computablePermissions

      public void computablePermissions(ComputablePermissionsRequest request, io.grpc.stub.StreamObserver<ComputablePermissionsResponse> responseObserver)
       ComputablePermissions returns the set of permissions that compute based off a relation
 in the current schema. For example, if the schema has a relation `viewer` and a permission
 `view` defined as `permission view = viewer + editor`, then the
 computable permissions for the relation `viewer` will include `view`.

    • dependentRelations

      public void dependentRelations(DependentRelationsRequest request, io.grpc.stub.StreamObserver<DependentRelationsResponse> responseObserver)
       DependentRelations returns the set of relations and permissions that used
 to compute a permission, recursively, in the current schema. It is the
 inverse of the ComputablePermissions API.

    • diffSchema

      public void diffSchema(DiffSchemaRequest request, io.grpc.stub.StreamObserver<DiffSchemaResponse> responseObserver)
       DiffSchema returns the difference between the specified schema and the current
 schema stored in SpiceDB.