Documentation
¶
Overview ¶
Package connectedobjects contains the code that handles the ConnectedObjects API
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConditionalResultStatus ¶
type ConditionalResultStatus int
const ( RequiresFurtherEvalStatus ConditionalResultStatus = iota NoFurtherEvalStatus )
type ConnectedObjectsQuery ¶
type ConnectedObjectsQuery struct {
// contains filtered or unexported fields
}
func NewConnectedObjectsQuery ¶
func NewConnectedObjectsQuery(ds storage.RelationshipTupleReader, ts *typesystem.TypeSystem, opts ...ConnectedObjectsQueryOption) *ConnectedObjectsQuery
func (*ConnectedObjectsQuery) Execute ¶
func (c *ConnectedObjectsQuery) Execute( ctx context.Context, req *ConnectedObjectsRequest, resultChan chan<- *ConnectedObjectsResult, ) error
Execute yields all the objects of the provided objectType that the given user has a specific relation with. The results will be limited by the request maxResults. If a 0 maxResults is provided then all objects of the provided objectType will be returned.
type ConnectedObjectsQueryOption ¶
type ConnectedObjectsQueryOption func(d *ConnectedObjectsQuery)
func WithMaxResults ¶
func WithMaxResults(maxResults uint32) ConnectedObjectsQueryOption
func WithResolveNodeBreadthLimit ¶
func WithResolveNodeBreadthLimit(limit uint32) ConnectedObjectsQueryOption
func WithResolveNodeLimit ¶
func WithResolveNodeLimit(limit uint32) ConnectedObjectsQueryOption
type ConnectedObjectsRequest ¶
type ConnectedObjectsResult ¶
type ConnectedObjectsResult struct {
Object string
ResultStatus ConditionalResultStatus
}
type UserRef ¶
type UserRef struct {
// Types that are assignable to Ref
// *UserRef_Object
// *UserRef_TypedWildcard
// *UserRef_ObjectRelation
Ref IsUserRef
}
type UserRefObject ¶
func (*UserRefObject) GetObjectType ¶
func (u *UserRefObject) GetObjectType() string
func (*UserRefObject) String ¶
func (u *UserRefObject) String() string
type UserRefObjectRelation ¶
type UserRefObjectRelation struct {
ObjectRelation *openfgav1.ObjectRelation
}
func (*UserRefObjectRelation) GetObjectType ¶
func (u *UserRefObjectRelation) GetObjectType() string
func (*UserRefObjectRelation) String ¶
func (u *UserRefObjectRelation) String() string
type UserRefTypedWildcard ¶
type UserRefTypedWildcard struct {
Type string
}
func (*UserRefTypedWildcard) GetObjectType ¶
func (u *UserRefTypedWildcard) GetObjectType() string
func (*UserRefTypedWildcard) String ¶
func (u *UserRefTypedWildcard) String() string
Click to show internal directories.
Click to hide internal directories.