Documentation ¶
Index ¶
- Variables
- func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)
- type ReadSchemaRequest
- func (*ReadSchemaRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ReadSchemaRequest) GetObjectDefinitionsNames() []string
- func (*ReadSchemaRequest) ProtoMessage()
- func (x *ReadSchemaRequest) ProtoReflect() protoreflect.Message
- func (x *ReadSchemaRequest) Reset()
- func (x *ReadSchemaRequest) String() string
- func (m *ReadSchemaRequest) Validate() error
- type ReadSchemaRequestValidationError
- func (e ReadSchemaRequestValidationError) Cause() error
- func (e ReadSchemaRequestValidationError) Error() string
- func (e ReadSchemaRequestValidationError) ErrorName() string
- func (e ReadSchemaRequestValidationError) Field() string
- func (e ReadSchemaRequestValidationError) Key() bool
- func (e ReadSchemaRequestValidationError) Reason() string
- type ReadSchemaResponse
- func (*ReadSchemaResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ReadSchemaResponse) GetObjectDefinitions() []string
- func (*ReadSchemaResponse) ProtoMessage()
- func (x *ReadSchemaResponse) ProtoReflect() protoreflect.Message
- func (x *ReadSchemaResponse) Reset()
- func (x *ReadSchemaResponse) String() string
- func (m *ReadSchemaResponse) Validate() error
- type ReadSchemaResponseValidationError
- func (e ReadSchemaResponseValidationError) Cause() error
- func (e ReadSchemaResponseValidationError) Error() string
- func (e ReadSchemaResponseValidationError) ErrorName() string
- func (e ReadSchemaResponseValidationError) Field() string
- func (e ReadSchemaResponseValidationError) Key() bool
- func (e ReadSchemaResponseValidationError) Reason() string
- type SchemaServiceClient
- type SchemaServiceServer
- type UnimplementedSchemaServiceServer
- type UnsafeSchemaServiceServer
- type WriteSchemaRequest
- func (*WriteSchemaRequest) Descriptor() ([]byte, []int)deprecated
- func (x *WriteSchemaRequest) GetSchema() string
- func (*WriteSchemaRequest) ProtoMessage()
- func (x *WriteSchemaRequest) ProtoReflect() protoreflect.Message
- func (x *WriteSchemaRequest) Reset()
- func (x *WriteSchemaRequest) String() string
- func (m *WriteSchemaRequest) Validate() error
- type WriteSchemaRequestValidationError
- func (e WriteSchemaRequestValidationError) Cause() error
- func (e WriteSchemaRequestValidationError) Error() string
- func (e WriteSchemaRequestValidationError) ErrorName() string
- func (e WriteSchemaRequestValidationError) Field() string
- func (e WriteSchemaRequestValidationError) Key() bool
- func (e WriteSchemaRequestValidationError) Reason() string
- type WriteSchemaResponse
- func (*WriteSchemaResponse) Descriptor() ([]byte, []int)deprecated
- func (x *WriteSchemaResponse) GetObjectDefinitionsNames() []string
- func (*WriteSchemaResponse) ProtoMessage()
- func (x *WriteSchemaResponse) ProtoReflect() protoreflect.Message
- func (x *WriteSchemaResponse) Reset()
- func (x *WriteSchemaResponse) String() string
- func (m *WriteSchemaResponse) Validate() error
- type WriteSchemaResponseValidationError
- func (e WriteSchemaResponseValidationError) Cause() error
- func (e WriteSchemaResponseValidationError) Error() string
- func (e WriteSchemaResponseValidationError) ErrorName() string
- func (e WriteSchemaResponseValidationError) Field() string
- func (e WriteSchemaResponseValidationError) Key() bool
- func (e WriteSchemaResponseValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_authzed_api_v1alpha1_schema_proto protoreflect.FileDescriptor
var SchemaService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "authzed.api.v1alpha1.SchemaService", HandlerType: (*SchemaServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "ReadSchema", Handler: _SchemaService_ReadSchema_Handler, }, { MethodName: "WriteSchema", Handler: _SchemaService_WriteSchema_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "authzed/api/v1alpha1/schema.proto", }
SchemaService_ServiceDesc is the grpc.ServiceDesc for SchemaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSchemaServiceServer ¶
func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)
Types ¶
type ReadSchemaRequest ¶
type ReadSchemaRequest struct { // The list of names of the Object Definitions that are being requested. // // These names must be fully qualified with their namespace (e.g. // myblog/post). ObjectDefinitionsNames []string `` /* 129-byte string literal not displayed */ // contains filtered or unexported fields }
ReadSchemaRequest is the required data to read Object Definitions from a Schema.
func (*ReadSchemaRequest) Descriptor
deprecated
func (*ReadSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use ReadSchemaRequest.ProtoReflect.Descriptor instead.
func (*ReadSchemaRequest) GetObjectDefinitionsNames ¶
func (x *ReadSchemaRequest) GetObjectDefinitionsNames() []string
func (*ReadSchemaRequest) ProtoMessage ¶
func (*ReadSchemaRequest) ProtoMessage()
func (*ReadSchemaRequest) ProtoReflect ¶
func (x *ReadSchemaRequest) ProtoReflect() protoreflect.Message
func (*ReadSchemaRequest) Reset ¶
func (x *ReadSchemaRequest) Reset()
func (*ReadSchemaRequest) String ¶
func (x *ReadSchemaRequest) String() string
func (*ReadSchemaRequest) Validate ¶
func (m *ReadSchemaRequest) Validate() error
Validate checks the field values on ReadSchemaRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ReadSchemaRequestValidationError ¶
type ReadSchemaRequestValidationError struct {
// contains filtered or unexported fields
}
ReadSchemaRequestValidationError is the validation error returned by ReadSchemaRequest.Validate if the designated constraints aren't met.
func (ReadSchemaRequestValidationError) Cause ¶
func (e ReadSchemaRequestValidationError) Cause() error
Cause function returns cause value.
func (ReadSchemaRequestValidationError) Error ¶
func (e ReadSchemaRequestValidationError) Error() string
Error satisfies the builtin error interface
func (ReadSchemaRequestValidationError) ErrorName ¶
func (e ReadSchemaRequestValidationError) ErrorName() string
ErrorName returns error name.
func (ReadSchemaRequestValidationError) Field ¶
func (e ReadSchemaRequestValidationError) Field() string
Field function returns field value.
func (ReadSchemaRequestValidationError) Key ¶
func (e ReadSchemaRequestValidationError) Key() bool
Key function returns key value.
func (ReadSchemaRequestValidationError) Reason ¶
func (e ReadSchemaRequestValidationError) Reason() string
Reason function returns reason value.
type ReadSchemaResponse ¶
type ReadSchemaResponse struct { // The Object Definitions that were requested. ObjectDefinitions []string `protobuf:"bytes,1,rep,name=object_definitions,json=objectDefinitions,proto3" json:"object_definitions,omitempty"` // contains filtered or unexported fields }
ReadSchemaResponse is the resulting data after having read the Object Definitions from a Schema.
func (*ReadSchemaResponse) Descriptor
deprecated
func (*ReadSchemaResponse) Descriptor() ([]byte, []int)
Deprecated: Use ReadSchemaResponse.ProtoReflect.Descriptor instead.
func (*ReadSchemaResponse) GetObjectDefinitions ¶
func (x *ReadSchemaResponse) GetObjectDefinitions() []string
func (*ReadSchemaResponse) ProtoMessage ¶
func (*ReadSchemaResponse) ProtoMessage()
func (*ReadSchemaResponse) ProtoReflect ¶
func (x *ReadSchemaResponse) ProtoReflect() protoreflect.Message
func (*ReadSchemaResponse) Reset ¶
func (x *ReadSchemaResponse) Reset()
func (*ReadSchemaResponse) String ¶
func (x *ReadSchemaResponse) String() string
func (*ReadSchemaResponse) Validate ¶
func (m *ReadSchemaResponse) Validate() error
Validate checks the field values on ReadSchemaResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ReadSchemaResponseValidationError ¶
type ReadSchemaResponseValidationError struct {
// contains filtered or unexported fields
}
ReadSchemaResponseValidationError is the validation error returned by ReadSchemaResponse.Validate if the designated constraints aren't met.
func (ReadSchemaResponseValidationError) Cause ¶
func (e ReadSchemaResponseValidationError) Cause() error
Cause function returns cause value.
func (ReadSchemaResponseValidationError) Error ¶
func (e ReadSchemaResponseValidationError) Error() string
Error satisfies the builtin error interface
func (ReadSchemaResponseValidationError) ErrorName ¶
func (e ReadSchemaResponseValidationError) ErrorName() string
ErrorName returns error name.
func (ReadSchemaResponseValidationError) Field ¶
func (e ReadSchemaResponseValidationError) Field() string
Field function returns field value.
func (ReadSchemaResponseValidationError) Key ¶
func (e ReadSchemaResponseValidationError) Key() bool
Key function returns key value.
func (ReadSchemaResponseValidationError) Reason ¶
func (e ReadSchemaResponseValidationError) Reason() string
Reason function returns reason value.
type SchemaServiceClient ¶
type SchemaServiceClient interface { // Read returns the current Object Definitions for a Permissions System. // // Errors include: // - INVALID_ARGUMENT: a provided value has failed to semantically validate // - NOT_FOUND: one of the Object Definitions being requested does not exist ReadSchema(ctx context.Context, in *ReadSchemaRequest, opts ...grpc.CallOption) (*ReadSchemaResponse, error) // Write overwrites the current Object Definitions for a Permissions System. // // Any Object Definitions that exist, but are not included will be deleted. WriteSchema(ctx context.Context, in *WriteSchemaRequest, opts ...grpc.CallOption) (*WriteSchemaResponse, error) }
SchemaServiceClient is the client API for SchemaService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewSchemaServiceClient ¶
func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient
type SchemaServiceServer ¶
type SchemaServiceServer interface { // Read returns the current Object Definitions for a Permissions System. // // Errors include: // - INVALID_ARGUMENT: a provided value has failed to semantically validate // - NOT_FOUND: one of the Object Definitions being requested does not exist ReadSchema(context.Context, *ReadSchemaRequest) (*ReadSchemaResponse, error) // Write overwrites the current Object Definitions for a Permissions System. // // Any Object Definitions that exist, but are not included will be deleted. WriteSchema(context.Context, *WriteSchemaRequest) (*WriteSchemaResponse, error) // contains filtered or unexported methods }
SchemaServiceServer is the server API for SchemaService service. All implementations must embed UnimplementedSchemaServiceServer for forward compatibility
type UnimplementedSchemaServiceServer ¶
type UnimplementedSchemaServiceServer struct { }
UnimplementedSchemaServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedSchemaServiceServer) ReadSchema ¶
func (UnimplementedSchemaServiceServer) ReadSchema(context.Context, *ReadSchemaRequest) (*ReadSchemaResponse, error)
func (UnimplementedSchemaServiceServer) WriteSchema ¶
func (UnimplementedSchemaServiceServer) WriteSchema(context.Context, *WriteSchemaRequest) (*WriteSchemaResponse, error)
type UnsafeSchemaServiceServer ¶
type UnsafeSchemaServiceServer interface {
// contains filtered or unexported methods
}
UnsafeSchemaServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SchemaServiceServer will result in compilation errors.
type WriteSchemaRequest ¶
type WriteSchemaRequest struct { // The Schema containing one or more Object Definitions that will be written // to the Permissions System. Schema string `protobuf:"bytes,1,opt,name=schema,proto3" json:"schema,omitempty"` // 256KiB // contains filtered or unexported fields }
WriteSchemaRequest is the required data used to "upsert" the Schema of a Permissions System.
func (*WriteSchemaRequest) Descriptor
deprecated
func (*WriteSchemaRequest) Descriptor() ([]byte, []int)
Deprecated: Use WriteSchemaRequest.ProtoReflect.Descriptor instead.
func (*WriteSchemaRequest) GetSchema ¶
func (x *WriteSchemaRequest) GetSchema() string
func (*WriteSchemaRequest) ProtoMessage ¶
func (*WriteSchemaRequest) ProtoMessage()
func (*WriteSchemaRequest) ProtoReflect ¶
func (x *WriteSchemaRequest) ProtoReflect() protoreflect.Message
func (*WriteSchemaRequest) Reset ¶
func (x *WriteSchemaRequest) Reset()
func (*WriteSchemaRequest) String ¶
func (x *WriteSchemaRequest) String() string
func (*WriteSchemaRequest) Validate ¶
func (m *WriteSchemaRequest) Validate() error
Validate checks the field values on WriteSchemaRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type WriteSchemaRequestValidationError ¶
type WriteSchemaRequestValidationError struct {
// contains filtered or unexported fields
}
WriteSchemaRequestValidationError is the validation error returned by WriteSchemaRequest.Validate if the designated constraints aren't met.
func (WriteSchemaRequestValidationError) Cause ¶
func (e WriteSchemaRequestValidationError) Cause() error
Cause function returns cause value.
func (WriteSchemaRequestValidationError) Error ¶
func (e WriteSchemaRequestValidationError) Error() string
Error satisfies the builtin error interface
func (WriteSchemaRequestValidationError) ErrorName ¶
func (e WriteSchemaRequestValidationError) ErrorName() string
ErrorName returns error name.
func (WriteSchemaRequestValidationError) Field ¶
func (e WriteSchemaRequestValidationError) Field() string
Field function returns field value.
func (WriteSchemaRequestValidationError) Key ¶
func (e WriteSchemaRequestValidationError) Key() bool
Key function returns key value.
func (WriteSchemaRequestValidationError) Reason ¶
func (e WriteSchemaRequestValidationError) Reason() string
Reason function returns reason value.
type WriteSchemaResponse ¶
type WriteSchemaResponse struct { // The names of the Object Definitions that were written. ObjectDefinitionsNames []string `` /* 129-byte string literal not displayed */ // contains filtered or unexported fields }
WriteSchemaResponse is the resulting data after having written a Schema to a Permissions System.
func (*WriteSchemaResponse) Descriptor
deprecated
func (*WriteSchemaResponse) Descriptor() ([]byte, []int)
Deprecated: Use WriteSchemaResponse.ProtoReflect.Descriptor instead.
func (*WriteSchemaResponse) GetObjectDefinitionsNames ¶
func (x *WriteSchemaResponse) GetObjectDefinitionsNames() []string
func (*WriteSchemaResponse) ProtoMessage ¶
func (*WriteSchemaResponse) ProtoMessage()
func (*WriteSchemaResponse) ProtoReflect ¶
func (x *WriteSchemaResponse) ProtoReflect() protoreflect.Message
func (*WriteSchemaResponse) Reset ¶
func (x *WriteSchemaResponse) Reset()
func (*WriteSchemaResponse) String ¶
func (x *WriteSchemaResponse) String() string
func (*WriteSchemaResponse) Validate ¶
func (m *WriteSchemaResponse) Validate() error
Validate checks the field values on WriteSchemaResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type WriteSchemaResponseValidationError ¶
type WriteSchemaResponseValidationError struct {
// contains filtered or unexported fields
}
WriteSchemaResponseValidationError is the validation error returned by WriteSchemaResponse.Validate if the designated constraints aren't met.
func (WriteSchemaResponseValidationError) Cause ¶
func (e WriteSchemaResponseValidationError) Cause() error
Cause function returns cause value.
func (WriteSchemaResponseValidationError) Error ¶
func (e WriteSchemaResponseValidationError) Error() string
Error satisfies the builtin error interface
func (WriteSchemaResponseValidationError) ErrorName ¶
func (e WriteSchemaResponseValidationError) ErrorName() string
ErrorName returns error name.
func (WriteSchemaResponseValidationError) Field ¶
func (e WriteSchemaResponseValidationError) Field() string
Field function returns field value.
func (WriteSchemaResponseValidationError) Key ¶
func (e WriteSchemaResponseValidationError) Key() bool
Key function returns key value.
func (WriteSchemaResponseValidationError) Reason ¶
func (e WriteSchemaResponseValidationError) Reason() string
Reason function returns reason value.