apiv1alpha1grpc

Documentation

Index

• Constants
• Variables
• func RegisterSchemaServiceServer(s grpc.ServiceRegistrar, srv SchemaServiceServer)
• func RegisterWatchResourcesServiceServer(s grpc.ServiceRegistrar, srv WatchResourcesServiceServer)
• type SchemaServiceClient
  • func NewSchemaServiceClient(cc grpc.ClientConnInterface) SchemaServiceClient
• type SchemaServiceServer
• type UnimplementedSchemaServiceServer
  • func (UnimplementedSchemaServiceServer) ReadSchema(context.Context, *v1alpha1.ReadSchemaRequest) (*v1alpha1.ReadSchemaResponse, error)
  • func (UnimplementedSchemaServiceServer) WriteSchema(context.Context, *v1alpha1.WriteSchemaRequest) (*v1alpha1.WriteSchemaResponse, error)
• type UnimplementedWatchResourcesServiceServer
  • func (UnimplementedWatchResourcesServiceServer) WatchResources(*v1alpha1.WatchResourcesRequest, WatchResourcesService_WatchResourcesServer) error
• type UnsafeSchemaServiceServer
• type UnsafeWatchResourcesServiceServer
• type WatchResourcesServiceClient
  • func NewWatchResourcesServiceClient(cc grpc.ClientConnInterface) WatchResourcesServiceClient
• type WatchResourcesServiceServer
• type WatchResourcesService_WatchResourcesClient
• type WatchResourcesService_WatchResourcesServer

Constants

const (
	SchemaService_ReadSchema_FullMethodName  = "/authzed.api.v1alpha1.SchemaService/ReadSchema"
	SchemaService_WriteSchema_FullMethodName = "/authzed.api.v1alpha1.SchemaService/WriteSchema"
)

const (
	WatchResourcesService_WatchResources_FullMethodName = "/authzed.api.v1alpha1.WatchResourcesService/WatchResources"
)

Variables

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)

var WatchResourcesService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "authzed.api.v1alpha1.WatchResourcesService",
	HandlerType: (*WatchResourcesServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "WatchResources",
			Handler:       _WatchResourcesService_WatchResources_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "authzed/api/v1alpha1/watchresources_service.proto",
}

WatchResourcesService_ServiceDesc is the grpc.ServiceDesc for WatchResourcesService 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)

func RegisterWatchResourcesServiceServer

func RegisterWatchResourcesServiceServer(s grpc.ServiceRegistrar, srv WatchResourcesServiceServer)

Types

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 *v1alpha1.ReadSchemaRequest, opts ...grpc.CallOption) (*v1alpha1.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 *v1alpha1.WriteSchemaRequest, opts ...grpc.CallOption) (*v1alpha1.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, *v1alpha1.ReadSchemaRequest) (*v1alpha1.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, *v1alpha1.WriteSchemaRequest) (*v1alpha1.WriteSchemaResponse, error)
}

SchemaServiceServer is the server API for SchemaService service. All implementations should embed UnimplementedSchemaServiceServer for forward compatibility

type UnimplementedSchemaServiceServer

type UnimplementedSchemaServiceServer struct {
}

UnimplementedSchemaServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedSchemaServiceServer) ReadSchema

func (UnimplementedSchemaServiceServer) ReadSchema(context.Context, *v1alpha1.ReadSchemaRequest) (*v1alpha1.ReadSchemaResponse, error)

func (UnimplementedSchemaServiceServer) WriteSchema

func (UnimplementedSchemaServiceServer) WriteSchema(context.Context, *v1alpha1.WriteSchemaRequest) (*v1alpha1.WriteSchemaResponse, error)

type UnimplementedWatchResourcesServiceServer

type UnimplementedWatchResourcesServiceServer struct {
}

UnimplementedWatchResourcesServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedWatchResourcesServiceServer) WatchResources

func (UnimplementedWatchResourcesServiceServer) WatchResources(*v1alpha1.WatchResourcesRequest, WatchResourcesService_WatchResourcesServer) 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 UnsafeWatchResourcesServiceServer

type UnsafeWatchResourcesServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeWatchResourcesServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to WatchResourcesServiceServer will result in compilation errors.

type WatchResourcesServiceClient

type WatchResourcesServiceClient interface {
	// WatchResources initiates a watch for permission changes for the provided
	// (resource type, permission, subject) pair.
	WatchResources(ctx context.Context, in *v1alpha1.WatchResourcesRequest, opts ...grpc.CallOption) (WatchResourcesService_WatchResourcesClient, error)
}

WatchResourcesServiceClient is the client API for WatchResourcesService 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 NewWatchResourcesServiceClient

func NewWatchResourcesServiceClient(cc grpc.ClientConnInterface) WatchResourcesServiceClient

type WatchResourcesServiceServer

type WatchResourcesServiceServer interface {
	// WatchResources initiates a watch for permission changes for the provided
	// (resource type, permission, subject) pair.
	WatchResources(*v1alpha1.WatchResourcesRequest, WatchResourcesService_WatchResourcesServer) error
}

WatchResourcesServiceServer is the server API for WatchResourcesService service. All implementations should embed UnimplementedWatchResourcesServiceServer for forward compatibility

type WatchResourcesService_WatchResourcesClient

type WatchResourcesService_WatchResourcesClient interface {
	Recv() (*v1alpha1.WatchResourcesResponse, error)
	grpc.ClientStream
}

type WatchResourcesService_WatchResourcesServer

type WatchResourcesService_WatchResourcesServer interface {
	Send(*v1alpha1.WatchResourcesResponse) error
	grpc.ServerStream
}