reader

package
v0.31.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 2, 2024 License: Apache-2.0 Imports: 20 Imported by: 24

Documentation

Overview

Package reader is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Reader_GetObject_FullMethodName       = "/aserto.directory.reader.v3.Reader/GetObject"
	Reader_GetObjectMany_FullMethodName   = "/aserto.directory.reader.v3.Reader/GetObjectMany"
	Reader_GetObjects_FullMethodName      = "/aserto.directory.reader.v3.Reader/GetObjects"
	Reader_GetRelation_FullMethodName     = "/aserto.directory.reader.v3.Reader/GetRelation"
	Reader_GetRelations_FullMethodName    = "/aserto.directory.reader.v3.Reader/GetRelations"
	Reader_Check_FullMethodName           = "/aserto.directory.reader.v3.Reader/Check"
	Reader_CheckPermission_FullMethodName = "/aserto.directory.reader.v3.Reader/CheckPermission"
	Reader_CheckRelation_FullMethodName   = "/aserto.directory.reader.v3.Reader/CheckRelation"
	Reader_GetGraph_FullMethodName        = "/aserto.directory.reader.v3.Reader/GetGraph"
)

Variables

View Source 
var File_aserto_directory_reader_v3_reader_proto protoreflect.FileDescriptor
View Source 
var Reader_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "aserto.directory.reader.v3.Reader",
	HandlerType: (*ReaderServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetObject",
			Handler:    _Reader_GetObject_Handler,
		},
		{
			MethodName: "GetObjectMany",
			Handler:    _Reader_GetObjectMany_Handler,
		},
		{
			MethodName: "GetObjects",
			Handler:    _Reader_GetObjects_Handler,
		},
		{
			MethodName: "GetRelation",
			Handler:    _Reader_GetRelation_Handler,
		},
		{
			MethodName: "GetRelations",
			Handler:    _Reader_GetRelations_Handler,
		},
		{
			MethodName: "Check",
			Handler:    _Reader_Check_Handler,
		},
		{
			MethodName: "CheckPermission",
			Handler:    _Reader_CheckPermission_Handler,
		},
		{
			MethodName: "CheckRelation",
			Handler:    _Reader_CheckRelation_Handler,
		},
		{
			MethodName: "GetGraph",
			Handler:    _Reader_GetGraph_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "aserto/directory/reader/v3/reader.proto",
}

Reader_ServiceDesc is the grpc.ServiceDesc for Reader service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterReaderHandler 

func RegisterReaderHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterReaderHandler registers the http handlers for service Reader to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterReaderHandlerClient 

func RegisterReaderHandlerClient(ctx context.Context, mux *runtime.ServeMux, client ReaderClient) error

RegisterReaderHandlerClient registers the http handlers for service Reader to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "ReaderClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "ReaderClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "ReaderClient" to call the correct interceptors. This client ignores the HTTP middlewares.

func RegisterReaderHandlerFromEndpoint 

func RegisterReaderHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterReaderHandlerFromEndpoint is same as RegisterReaderHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterReaderHandlerServer 

func RegisterReaderHandlerServer(ctx context.Context, mux *runtime.ServeMux, server ReaderServer) error

RegisterReaderHandlerServer registers the http handlers for service Reader to "mux". UnaryRPC :call ReaderServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterReaderHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterReaderServer 

func RegisterReaderServer(s grpc.ServiceRegistrar, srv ReaderServer)

Types

type CheckPermissionRequest 

type CheckPermissionRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// permission name
	Permission string `protobuf:"bytes,3,opt,name=permission,proto3" json:"permission,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,4,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,5,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// collect trace information
	Trace bool `protobuf:"varint,7,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckPermissionRequest) Descriptor deprecated 

func (*CheckPermissionRequest) Descriptor() ([]byte, []int)

Deprecated: Use CheckPermissionRequest.ProtoReflect.Descriptor instead.

func (*CheckPermissionRequest) GetObjectId 

func (x *CheckPermissionRequest) GetObjectId() string

func (*CheckPermissionRequest) GetObjectType 

func (x *CheckPermissionRequest) GetObjectType() string

func (*CheckPermissionRequest) GetPermission 

func (x *CheckPermissionRequest) GetPermission() string

func (*CheckPermissionRequest) GetSubjectId 

func (x *CheckPermissionRequest) GetSubjectId() string

func (*CheckPermissionRequest) GetSubjectType 

func (x *CheckPermissionRequest) GetSubjectType() string

func (*CheckPermissionRequest) GetTrace 

func (x *CheckPermissionRequest) GetTrace() bool

func (*CheckPermissionRequest) ProtoMessage 

func (*CheckPermissionRequest) ProtoMessage()

func (*CheckPermissionRequest) ProtoReflect 

func (x *CheckPermissionRequest) ProtoReflect() protoreflect.Message

func (*CheckPermissionRequest) Reset 

func (x *CheckPermissionRequest) Reset()

func (*CheckPermissionRequest) String 

func (x *CheckPermissionRequest) String() string

type CheckPermissionResponse 

type CheckPermissionResponse struct {

	// check result
	Check bool `protobuf:"varint,1,opt,name=check,proto3" json:"check,omitempty"`
	// trace information
	Trace []string `protobuf:"bytes,2,rep,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckPermissionResponse) Descriptor deprecated 

func (*CheckPermissionResponse) Descriptor() ([]byte, []int)

Deprecated: Use CheckPermissionResponse.ProtoReflect.Descriptor instead.

func (*CheckPermissionResponse) GetCheck 

func (x *CheckPermissionResponse) GetCheck() bool

func (*CheckPermissionResponse) GetTrace 

func (x *CheckPermissionResponse) GetTrace() []string

func (*CheckPermissionResponse) ProtoMessage 

func (*CheckPermissionResponse) ProtoMessage()

func (*CheckPermissionResponse) ProtoReflect 

func (x *CheckPermissionResponse) ProtoReflect() protoreflect.Message

func (*CheckPermissionResponse) Reset 

func (x *CheckPermissionResponse) Reset()

func (*CheckPermissionResponse) String 

func (x *CheckPermissionResponse) String() string

type CheckRelationRequest 

type CheckRelationRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// relation name
	Relation string `protobuf:"bytes,3,opt,name=relation,proto3" json:"relation,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,4,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,5,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// collect trace information
	Trace bool `protobuf:"varint,7,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckRelationRequest) Descriptor deprecated 

func (*CheckRelationRequest) Descriptor() ([]byte, []int)

Deprecated: Use CheckRelationRequest.ProtoReflect.Descriptor instead.

func (*CheckRelationRequest) GetObjectId 

func (x *CheckRelationRequest) GetObjectId() string

func (*CheckRelationRequest) GetObjectType 

func (x *CheckRelationRequest) GetObjectType() string

func (*CheckRelationRequest) GetRelation 

func (x *CheckRelationRequest) GetRelation() string

func (*CheckRelationRequest) GetSubjectId 

func (x *CheckRelationRequest) GetSubjectId() string

func (*CheckRelationRequest) GetSubjectType 

func (x *CheckRelationRequest) GetSubjectType() string

func (*CheckRelationRequest) GetTrace 

func (x *CheckRelationRequest) GetTrace() bool

func (*CheckRelationRequest) ProtoMessage 

func (*CheckRelationRequest) ProtoMessage()

func (*CheckRelationRequest) ProtoReflect 

func (x *CheckRelationRequest) ProtoReflect() protoreflect.Message

func (*CheckRelationRequest) Reset 

func (x *CheckRelationRequest) Reset()

func (*CheckRelationRequest) String 

func (x *CheckRelationRequest) String() string

type CheckRelationResponse 

type CheckRelationResponse struct {

	// check result
	Check bool `protobuf:"varint,1,opt,name=check,proto3" json:"check,omitempty"`
	// trace information
	Trace []string `protobuf:"bytes,2,rep,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckRelationResponse) Descriptor deprecated 

func (*CheckRelationResponse) Descriptor() ([]byte, []int)

Deprecated: Use CheckRelationResponse.ProtoReflect.Descriptor instead.

func (*CheckRelationResponse) GetCheck 

func (x *CheckRelationResponse) GetCheck() bool

func (*CheckRelationResponse) GetTrace 

func (x *CheckRelationResponse) GetTrace() []string

func (*CheckRelationResponse) ProtoMessage 

func (*CheckRelationResponse) ProtoMessage()

func (*CheckRelationResponse) ProtoReflect 

func (x *CheckRelationResponse) ProtoReflect() protoreflect.Message

func (*CheckRelationResponse) Reset 

func (x *CheckRelationResponse) Reset()

func (*CheckRelationResponse) String 

func (x *CheckRelationResponse) String() string

type CheckRequest 

type CheckRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// relation name
	Relation string `protobuf:"bytes,3,opt,name=relation,proto3" json:"relation,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,4,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,5,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// collect trace information
	Trace bool `protobuf:"varint,7,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckRequest) Descriptor deprecated 

func (*CheckRequest) Descriptor() ([]byte, []int)

Deprecated: Use CheckRequest.ProtoReflect.Descriptor instead.

func (*CheckRequest) GetObjectId 

func (x *CheckRequest) GetObjectId() string

func (*CheckRequest) GetObjectType 

func (x *CheckRequest) GetObjectType() string

func (*CheckRequest) GetRelation 

func (x *CheckRequest) GetRelation() string

func (*CheckRequest) GetSubjectId 

func (x *CheckRequest) GetSubjectId() string

func (*CheckRequest) GetSubjectType 

func (x *CheckRequest) GetSubjectType() string

func (*CheckRequest) GetTrace 

func (x *CheckRequest) GetTrace() bool

func (*CheckRequest) ProtoMessage 

func (*CheckRequest) ProtoMessage()

func (*CheckRequest) ProtoReflect 

func (x *CheckRequest) ProtoReflect() protoreflect.Message

func (*CheckRequest) Reset 

func (x *CheckRequest) Reset()

func (*CheckRequest) String 

func (x *CheckRequest) String() string

type CheckResponse 

type CheckResponse struct {

	// check result
	Check bool `protobuf:"varint,1,opt,name=check,proto3" json:"check,omitempty"`
	// trace information
	Trace []string `protobuf:"bytes,2,rep,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckResponse) Descriptor deprecated 

func (*CheckResponse) Descriptor() ([]byte, []int)

Deprecated: Use CheckResponse.ProtoReflect.Descriptor instead.

func (*CheckResponse) GetCheck 

func (x *CheckResponse) GetCheck() bool

func (*CheckResponse) GetTrace 

func (x *CheckResponse) GetTrace() []string

func (*CheckResponse) ProtoMessage 

func (*CheckResponse) ProtoMessage()

func (*CheckResponse) ProtoReflect 

func (x *CheckResponse) ProtoReflect() protoreflect.Message

func (*CheckResponse) Reset 

func (x *CheckResponse) Reset()

func (*CheckResponse) String 

func (x *CheckResponse) String() string

type GetGraphRequest 

type GetGraphRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,3,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,4,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// relation name
	Relation string `protobuf:"bytes,5,opt,name=relation,proto3" json:"relation,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,6,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,7,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// subject relation
	SubjectRelation string `protobuf:"bytes,8,opt,name=subject_relation,json=subjectRelation,proto3" json:"subject_relation,omitempty"`
	// return graph paths for each result
	Explain bool `protobuf:"varint,9,opt,name=explain,proto3" json:"explain,omitempty"`
	// collect trace information
	Trace bool `protobuf:"varint,10,opt,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGraphRequest) Descriptor deprecated 

func (*GetGraphRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetGraphRequest.ProtoReflect.Descriptor instead.

func (*GetGraphRequest) GetExplain added in v0.31.0 

func (x *GetGraphRequest) GetExplain() bool

func (*GetGraphRequest) GetObjectId 

func (x *GetGraphRequest) GetObjectId() string

func (*GetGraphRequest) GetObjectType 

func (x *GetGraphRequest) GetObjectType() string

func (*GetGraphRequest) GetRelation 

func (x *GetGraphRequest) GetRelation() string

func (*GetGraphRequest) GetSubjectId 

func (x *GetGraphRequest) GetSubjectId() string

func (*GetGraphRequest) GetSubjectRelation 

func (x *GetGraphRequest) GetSubjectRelation() string

func (*GetGraphRequest) GetSubjectType 

func (x *GetGraphRequest) GetSubjectType() string

func (*GetGraphRequest) GetTrace added in v0.31.0 

func (x *GetGraphRequest) GetTrace() bool

func (*GetGraphRequest) ProtoMessage 

func (*GetGraphRequest) ProtoMessage()

func (*GetGraphRequest) ProtoReflect 

func (x *GetGraphRequest) ProtoReflect() protoreflect.Message

func (*GetGraphRequest) Reset 

func (x *GetGraphRequest) Reset()

func (*GetGraphRequest) String 

func (x *GetGraphRequest) String() string

type GetGraphResponse 

type GetGraphResponse struct {

	// matching object identifiers
	Results []*v3.ObjectIdentifier `protobuf:"bytes,2,rep,name=results,proto3" json:"results,omitempty"`
	// explanation of results
	Explanation *structpb.Struct `protobuf:"bytes,3,opt,name=explanation,proto3" json:"explanation,omitempty"`
	// trace information
	Trace []string `protobuf:"bytes,4,rep,name=trace,proto3" json:"trace,omitempty"`
	// contains filtered or unexported fields
}

func (*GetGraphResponse) Descriptor deprecated 

func (*GetGraphResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetGraphResponse.ProtoReflect.Descriptor instead.

func (*GetGraphResponse) GetExplanation added in v0.31.0 

func (x *GetGraphResponse) GetExplanation() *structpb.Struct

func (*GetGraphResponse) GetResults 

func (x *GetGraphResponse) GetResults() []*v3.ObjectIdentifier

func (*GetGraphResponse) GetTrace added in v0.31.0 

func (x *GetGraphResponse) GetTrace() []string

func (*GetGraphResponse) ProtoMessage 

func (*GetGraphResponse) ProtoMessage()

func (*GetGraphResponse) ProtoReflect 

func (x *GetGraphResponse) ProtoReflect() protoreflect.Message

func (*GetGraphResponse) Reset 

func (x *GetGraphResponse) Reset()

func (*GetGraphResponse) String 

func (x *GetGraphResponse) String() string

type GetObjectManyRequest 

type GetObjectManyRequest struct {

	// object identifier list
	Param []*v3.ObjectIdentifier `protobuf:"bytes,1,rep,name=param,proto3" json:"param,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectManyRequest) Descriptor deprecated 

func (*GetObjectManyRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectManyRequest.ProtoReflect.Descriptor instead.

func (*GetObjectManyRequest) GetParam 

func (x *GetObjectManyRequest) GetParam() []*v3.ObjectIdentifier

func (*GetObjectManyRequest) ProtoMessage 

func (*GetObjectManyRequest) ProtoMessage()

func (*GetObjectManyRequest) ProtoReflect 

func (x *GetObjectManyRequest) ProtoReflect() protoreflect.Message

func (*GetObjectManyRequest) Reset 

func (x *GetObjectManyRequest) Reset()

func (*GetObjectManyRequest) String 

func (x *GetObjectManyRequest) String() string

type GetObjectManyResponse 

type GetObjectManyResponse struct {

	// array of object instances
	Results []*v3.Object `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectManyResponse) Descriptor deprecated 

func (*GetObjectManyResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectManyResponse.ProtoReflect.Descriptor instead.

func (*GetObjectManyResponse) GetResults 

func (x *GetObjectManyResponse) GetResults() []*v3.Object

func (*GetObjectManyResponse) ProtoMessage 

func (*GetObjectManyResponse) ProtoMessage()

func (*GetObjectManyResponse) ProtoReflect 

func (x *GetObjectManyResponse) ProtoReflect() protoreflect.Message

func (*GetObjectManyResponse) Reset 

func (x *GetObjectManyResponse) Reset()

func (*GetObjectManyResponse) String 

func (x *GetObjectManyResponse) String() string

type GetObjectRequest 

type GetObjectRequest struct {

	// object type name (lc-string)
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier (cs-string)
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// materialize the object relations objects
	WithRelations bool `protobuf:"varint,3,opt,name=with_relations,json=withRelations,proto3" json:"with_relations,omitempty"`
	// pagination request
	Page *v3.PaginationRequest `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectRequest) Descriptor deprecated 

func (*GetObjectRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectRequest.ProtoReflect.Descriptor instead.

func (*GetObjectRequest) GetObjectId 

func (x *GetObjectRequest) GetObjectId() string

func (*GetObjectRequest) GetObjectType 

func (x *GetObjectRequest) GetObjectType() string

func (*GetObjectRequest) GetPage 

func (x *GetObjectRequest) GetPage() *v3.PaginationRequest

func (*GetObjectRequest) GetWithRelations 

func (x *GetObjectRequest) GetWithRelations() bool

func (*GetObjectRequest) ProtoMessage 

func (*GetObjectRequest) ProtoMessage()

func (*GetObjectRequest) ProtoReflect 

func (x *GetObjectRequest) ProtoReflect() protoreflect.Message

func (*GetObjectRequest) Reset 

func (x *GetObjectRequest) Reset()

func (*GetObjectRequest) String 

func (x *GetObjectRequest) String() string

type GetObjectResponse 

type GetObjectResponse struct {

	// object instance
	Result *v3.Object `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// object relations
	Relations []*v3.Relation `protobuf:"bytes,4,rep,name=relations,proto3" json:"relations,omitempty"`
	// pagination response
	Page *v3.PaginationResponse `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectResponse) Descriptor deprecated 

func (*GetObjectResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectResponse.ProtoReflect.Descriptor instead.

func (*GetObjectResponse) GetPage 

func (x *GetObjectResponse) GetPage() *v3.PaginationResponse

func (*GetObjectResponse) GetRelations 

func (x *GetObjectResponse) GetRelations() []*v3.Relation

func (*GetObjectResponse) GetResult 

func (x *GetObjectResponse) GetResult() *v3.Object

func (*GetObjectResponse) ProtoMessage 

func (*GetObjectResponse) ProtoMessage()

func (*GetObjectResponse) ProtoReflect 

func (x *GetObjectResponse) ProtoReflect() protoreflect.Message

func (*GetObjectResponse) Reset 

func (x *GetObjectResponse) Reset()

func (*GetObjectResponse) String 

func (x *GetObjectResponse) String() string

type GetObjectsRequest 

type GetObjectsRequest struct {

	// object type name (lc-string)
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// pagination request
	Page *v3.PaginationRequest `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectsRequest) Descriptor deprecated 

func (*GetObjectsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectsRequest.ProtoReflect.Descriptor instead.

func (*GetObjectsRequest) GetObjectType 

func (x *GetObjectsRequest) GetObjectType() string

func (*GetObjectsRequest) GetPage 

func (x *GetObjectsRequest) GetPage() *v3.PaginationRequest

func (*GetObjectsRequest) ProtoMessage 

func (*GetObjectsRequest) ProtoMessage()

func (*GetObjectsRequest) ProtoReflect 

func (x *GetObjectsRequest) ProtoReflect() protoreflect.Message

func (*GetObjectsRequest) Reset 

func (x *GetObjectsRequest) Reset()

func (*GetObjectsRequest) String 

func (x *GetObjectsRequest) String() string

type GetObjectsResponse 

type GetObjectsResponse struct {

	// array of object instances
	Results []*v3.Object `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// pagination response
	Page *v3.PaginationResponse `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetObjectsResponse) Descriptor deprecated 

func (*GetObjectsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetObjectsResponse.ProtoReflect.Descriptor instead.

func (*GetObjectsResponse) GetPage 

func (x *GetObjectsResponse) GetPage() *v3.PaginationResponse

func (*GetObjectsResponse) GetResults 

func (x *GetObjectsResponse) GetResults() []*v3.Object

func (*GetObjectsResponse) ProtoMessage 

func (*GetObjectsResponse) ProtoMessage()

func (*GetObjectsResponse) ProtoReflect 

func (x *GetObjectsResponse) ProtoReflect() protoreflect.Message

func (*GetObjectsResponse) Reset 

func (x *GetObjectsResponse) Reset()

func (*GetObjectsResponse) String 

func (x *GetObjectsResponse) String() string

type GetRelationRequest 

type GetRelationRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// relation name
	Relation string `protobuf:"bytes,3,opt,name=relation,proto3" json:"relation,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,4,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,5,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// optional subject relation name
	SubjectRelation string `protobuf:"bytes,6,opt,name=subject_relation,json=subjectRelation,proto3" json:"subject_relation,omitempty"`
	// materialize relation objects
	WithObjects bool `protobuf:"varint,7,opt,name=with_objects,json=withObjects,proto3" json:"with_objects,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRelationRequest) Descriptor deprecated 

func (*GetRelationRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRelationRequest.ProtoReflect.Descriptor instead.

func (*GetRelationRequest) GetObjectId 

func (x *GetRelationRequest) GetObjectId() string

func (*GetRelationRequest) GetObjectType 

func (x *GetRelationRequest) GetObjectType() string

func (*GetRelationRequest) GetRelation 

func (x *GetRelationRequest) GetRelation() string

func (*GetRelationRequest) GetSubjectId 

func (x *GetRelationRequest) GetSubjectId() string

func (*GetRelationRequest) GetSubjectRelation 

func (x *GetRelationRequest) GetSubjectRelation() string

func (*GetRelationRequest) GetSubjectType 

func (x *GetRelationRequest) GetSubjectType() string

func (*GetRelationRequest) GetWithObjects 

func (x *GetRelationRequest) GetWithObjects() bool

func (*GetRelationRequest) ProtoMessage 

func (*GetRelationRequest) ProtoMessage()

func (*GetRelationRequest) ProtoReflect 

func (x *GetRelationRequest) ProtoReflect() protoreflect.Message

func (*GetRelationRequest) Reset 

func (x *GetRelationRequest) Reset()

func (*GetRelationRequest) String 

func (x *GetRelationRequest) String() string

type GetRelationResponse 

type GetRelationResponse struct {

	// relation instance
	Result *v3.Relation `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// map of materialized relation objects
	Objects map[string]*v3.Object `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*GetRelationResponse) Descriptor deprecated 

func (*GetRelationResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetRelationResponse.ProtoReflect.Descriptor instead.

func (*GetRelationResponse) GetObjects 

func (x *GetRelationResponse) GetObjects() map[string]*v3.Object

func (*GetRelationResponse) GetResult 

func (x *GetRelationResponse) GetResult() *v3.Relation

func (*GetRelationResponse) ProtoMessage 

func (*GetRelationResponse) ProtoMessage()

func (*GetRelationResponse) ProtoReflect 

func (x *GetRelationResponse) ProtoReflect() protoreflect.Message

func (*GetRelationResponse) Reset 

func (x *GetRelationResponse) Reset()

func (*GetRelationResponse) String 

func (x *GetRelationResponse) String() string

type GetRelationsRequest 

type GetRelationsRequest struct {

	// object type
	ObjectType string `protobuf:"bytes,1,opt,name=object_type,json=objectType,proto3" json:"object_type,omitempty"`
	// object identifier
	ObjectId string `protobuf:"bytes,2,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// relation name
	Relation string `protobuf:"bytes,3,opt,name=relation,proto3" json:"relation,omitempty"`
	// subject type
	SubjectType string `protobuf:"bytes,4,opt,name=subject_type,json=subjectType,proto3" json:"subject_type,omitempty"`
	// subject identifier
	SubjectId string `protobuf:"bytes,5,opt,name=subject_id,json=subjectId,proto3" json:"subject_id,omitempty"`
	// optional subject relation name
	SubjectRelation string `protobuf:"bytes,6,opt,name=subject_relation,json=subjectRelation,proto3" json:"subject_relation,omitempty"`
	// materialize relation objects
	WithObjects bool `protobuf:"varint,7,opt,name=with_objects,json=withObjects,proto3" json:"with_objects,omitempty"`
	// only return relations that do not have a subject relation.
	WithEmptySubjectRelation bool `` /* 138-byte string literal not displayed */
	// pagination request
	Page *v3.PaginationRequest `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRelationsRequest) Descriptor deprecated 

func (*GetRelationsRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetRelationsRequest.ProtoReflect.Descriptor instead.

func (*GetRelationsRequest) GetObjectId 

func (x *GetRelationsRequest) GetObjectId() string

func (*GetRelationsRequest) GetObjectType 

func (x *GetRelationsRequest) GetObjectType() string

func (*GetRelationsRequest) GetPage 

func (x *GetRelationsRequest) GetPage() *v3.PaginationRequest

func (*GetRelationsRequest) GetRelation 

func (x *GetRelationsRequest) GetRelation() string

func (*GetRelationsRequest) GetSubjectId 

func (x *GetRelationsRequest) GetSubjectId() string

func (*GetRelationsRequest) GetSubjectRelation 

func (x *GetRelationsRequest) GetSubjectRelation() string

func (*GetRelationsRequest) GetSubjectType 

func (x *GetRelationsRequest) GetSubjectType() string

func (*GetRelationsRequest) GetWithEmptySubjectRelation added in v0.30.9 

func (x *GetRelationsRequest) GetWithEmptySubjectRelation() bool

func (*GetRelationsRequest) GetWithObjects 

func (x *GetRelationsRequest) GetWithObjects() bool

func (*GetRelationsRequest) ProtoMessage 

func (*GetRelationsRequest) ProtoMessage()

func (*GetRelationsRequest) ProtoReflect 

func (x *GetRelationsRequest) ProtoReflect() protoreflect.Message

func (*GetRelationsRequest) Reset 

func (x *GetRelationsRequest) Reset()

func (*GetRelationsRequest) String 

func (x *GetRelationsRequest) String() string

type GetRelationsResponse 

type GetRelationsResponse struct {

	// array of relation instances
	Results []*v3.Relation `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// map of materialized relation objects
	Objects map[string]*v3.Object `` /* 155-byte string literal not displayed */
	// pagination response
	Page *v3.PaginationResponse `protobuf:"bytes,9,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

func (*GetRelationsResponse) Descriptor deprecated 

func (*GetRelationsResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetRelationsResponse.ProtoReflect.Descriptor instead.

func (*GetRelationsResponse) GetObjects 

func (x *GetRelationsResponse) GetObjects() map[string]*v3.Object

func (*GetRelationsResponse) GetPage 

func (x *GetRelationsResponse) GetPage() *v3.PaginationResponse

func (*GetRelationsResponse) GetResults 

func (x *GetRelationsResponse) GetResults() []*v3.Relation

func (*GetRelationsResponse) ProtoMessage 

func (*GetRelationsResponse) ProtoMessage()

func (*GetRelationsResponse) ProtoReflect 

func (x *GetRelationsResponse) ProtoReflect() protoreflect.Message

func (*GetRelationsResponse) Reset 

func (x *GetRelationsResponse) Reset()

func (*GetRelationsResponse) String 

func (x *GetRelationsResponse) String() string

type ReaderClient 

type ReaderClient interface {
	// get object
	GetObject(ctx context.Context, in *GetObjectRequest, opts ...grpc.CallOption) (*GetObjectResponse, error)
	// get multiple objects
	GetObjectMany(ctx context.Context, in *GetObjectManyRequest, opts ...grpc.CallOption) (*GetObjectManyResponse, error)
	// list objects
	GetObjects(ctx context.Context, in *GetObjectsRequest, opts ...grpc.CallOption) (*GetObjectsResponse, error)
	// get relation
	GetRelation(ctx context.Context, in *GetRelationRequest, opts ...grpc.CallOption) (*GetRelationResponse, error)
	// list relations
	GetRelations(ctx context.Context, in *GetRelationsRequest, opts ...grpc.CallOption) (*GetRelationsResponse, error)
	// check if subject has relation or permission with object
	Check(ctx context.Context, in *CheckRequest, opts ...grpc.CallOption) (*CheckResponse, error)
	// Deprecated: Do not use.
	// check permission (deprecated, use the check method)
	// Deprecated: use directory.v3.Check()
	CheckPermission(ctx context.Context, in *CheckPermissionRequest, opts ...grpc.CallOption) (*CheckPermissionResponse, error)
	// Deprecated: Do not use.
	// check relation (deprecated, use the check method)
	// Deprecated: use directory.v3.Check()
	CheckRelation(ctx context.Context, in *CheckRelationRequest, opts ...grpc.CallOption) (*CheckRelationResponse, error)
	// get object relationship graph
	GetGraph(ctx context.Context, in *GetGraphRequest, opts ...grpc.CallOption) (*GetGraphResponse, error)
}

ReaderClient is the client API for Reader 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 NewReaderClient 

func NewReaderClient(cc grpc.ClientConnInterface) ReaderClient

type ReaderServer 

type ReaderServer interface {
	// get object
	GetObject(context.Context, *GetObjectRequest) (*GetObjectResponse, error)
	// get multiple objects
	GetObjectMany(context.Context, *GetObjectManyRequest) (*GetObjectManyResponse, error)
	// list objects
	GetObjects(context.Context, *GetObjectsRequest) (*GetObjectsResponse, error)
	// get relation
	GetRelation(context.Context, *GetRelationRequest) (*GetRelationResponse, error)
	// list relations
	GetRelations(context.Context, *GetRelationsRequest) (*GetRelationsResponse, error)
	// check if subject has relation or permission with object
	Check(context.Context, *CheckRequest) (*CheckResponse, error)
	// Deprecated: Do not use.
	// check permission (deprecated, use the check method)
	// Deprecated: use directory.v3.Check()
	CheckPermission(context.Context, *CheckPermissionRequest) (*CheckPermissionResponse, error)
	// Deprecated: Do not use.
	// check relation (deprecated, use the check method)
	// Deprecated: use directory.v3.Check()
	CheckRelation(context.Context, *CheckRelationRequest) (*CheckRelationResponse, error)
	// get object relationship graph
	GetGraph(context.Context, *GetGraphRequest) (*GetGraphResponse, error)
}

ReaderServer is the server API for Reader service. All implementations should embed UnimplementedReaderServer for forward compatibility.

type UnimplementedReaderServer 

type UnimplementedReaderServer struct{}

UnimplementedReaderServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedReaderServer) Check 

func (UnimplementedReaderServer) Check(context.Context, *CheckRequest) (*CheckResponse, error)

func (UnimplementedReaderServer) CheckPermission 

func (UnimplementedReaderServer) CheckPermission(context.Context, *CheckPermissionRequest) (*CheckPermissionResponse, error)

func (UnimplementedReaderServer) CheckRelation 

func (UnimplementedReaderServer) CheckRelation(context.Context, *CheckRelationRequest) (*CheckRelationResponse, error)

func (UnimplementedReaderServer) GetGraph 

func (UnimplementedReaderServer) GetGraph(context.Context, *GetGraphRequest) (*GetGraphResponse, error)

func (UnimplementedReaderServer) GetObject 

func (UnimplementedReaderServer) GetObject(context.Context, *GetObjectRequest) (*GetObjectResponse, error)

func (UnimplementedReaderServer) GetObjectMany 

func (UnimplementedReaderServer) GetObjectMany(context.Context, *GetObjectManyRequest) (*GetObjectManyResponse, error)

func (UnimplementedReaderServer) GetObjects 

func (UnimplementedReaderServer) GetObjects(context.Context, *GetObjectsRequest) (*GetObjectsResponse, error)

func (UnimplementedReaderServer) GetRelation 

func (UnimplementedReaderServer) GetRelation(context.Context, *GetRelationRequest) (*GetRelationResponse, error)

func (UnimplementedReaderServer) GetRelations 

func (UnimplementedReaderServer) GetRelations(context.Context, *GetRelationsRequest) (*GetRelationsResponse, error)

type UnsafeReaderServer 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.