Package io.weaviate.client.v1.rbac.model

Class Permission<P extends Permission<P>>

java.lang.Object

io.weaviate.client.v1.rbac.model.Permission<P>

Direct Known Subclasses:

BackupsPermission, ClusterPermission, CollectionsPermission, DataPermission, NodesPermission, RolesPermission, TenantsPermission, UsersPermission

public abstract class Permission<P extends Permission<P>>
extends Object

Method Summary

Modifier and Type	Method	Description
static BackupsPermission	backups(String collection, BackupsPermission.Action... actions)	Create BackupsPermission for a collection.
protected boolean	canEqual(Object other)
static ClusterPermission	cluster(ClusterPermission.Action... actions)	Create ClusterPermission permission.
static CollectionsPermission	collections(String collection, CollectionsPermission.Action... actions)	Create permission for collection's configuration.
static DataPermission	data(String collection, DataPermission.Action... actions)	Create permissions for multiple actions for managing collection's data.
boolean	equals(Object o)
WeaviatePermission	firstToWeaviate()	Create WeaviatePermission with the first action in the actions list.
static Permission<?>	fromWeaviate(WeaviatePermission perm)	Convert WeaviatePermission to concrete Permission.
List<String>	getActions()
int	hashCode()
static final List<Permission<?>>	merge(List<Permission<?>> permissions)	Merge permissions by their type and targeted resource.
static NodesPermission	nodes(NodesPermission.Verbosity verbosity, NodesPermission.Action... actions)	Create NodesPermission scoped to all collections.
static NodesPermission	nodes(String collection, NodesPermission.Action... actions)	Create NodesPermission scoped to a specific collection.
static RolesPermission	roles(String role, RolesPermission.Action... actions)	Create RolesPermission for multiple actions.
static TenantsPermission	tenants(TenantsPermission.Action... actions)	Create TenantsPermission for a tenant.
String	toString()
List<WeaviatePermission>	toWeaviate()	Convert the permission to a list of WeaviatePermission.
static UsersPermission	users(UsersPermission.Action... actions)	Create UsersPermission.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getActions

public List<String> getActions()

firstToWeaviate

public WeaviatePermission firstToWeaviate()

Create WeaviatePermission with the first action in the actions list. This is meant to be used with PermissionChecker, which can only include a permission with a single action in the request.

toWeaviate

public List<WeaviatePermission> toWeaviate()

Convert the permission to a list of WeaviatePermission.

fromWeaviate

public static Permission<?> fromWeaviate(WeaviatePermission perm)

Convert WeaviatePermission to concrete Permission.

merge

public static final List<Permission<?>> merge(List<Permission<?>> permissions)

Merge permissions by their type and targeted resource. Weaviate server returns separate entries for each action, but working with a permission-per-resource model is more convenient.

Example: convert Data[read_data, MyCollection], Data[delete_data, MyCollection] to Data[[read_data, delete_data], MyCollection].

backups

public static BackupsPermission backups(String collection,
 BackupsPermission.Action... actions)

Create BackupsPermission for a collection.

Example: Permission.backups(BackupsPermission.Action.MANAGE, "Pizza")

cluster

public static ClusterPermission cluster(ClusterPermission.Action... actions)

Create ClusterPermission permission.

Example: Permission.cluster(ClusterPermission.Action.READ, "Pizza")

collections

public static CollectionsPermission collections(String collection,
 CollectionsPermission.Action... actions)

Create permission for collection's configuration.

Example: Permission.collections("Pizza", CollectionsPermission.Action.READ, CollectionsPermission.Action.UPDATE)

data

public static DataPermission data(String collection,
 DataPermission.Action... actions)

Create permissions for multiple actions for managing collection's data.

Example: Permission.data("Pizza", DataPermission.Action.READ, DataPermission.Action.UPDATE)

nodes

public static NodesPermission nodes(NodesPermission.Verbosity verbosity,
 NodesPermission.Action... actions)

Create NodesPermission scoped to all collections.

Example: Permission.nodes(NodesPermission.Verbosity.MINIMAL, NodesPermission.Action.READ)

nodes

public static NodesPermission nodes(String collection,
 NodesPermission.Action... actions)

Create NodesPermission scoped to a specific collection. Verbosity is set to NodesPermission.Verbosity.VERBOSE by default.

Example: Permission.nodes("Pizza", NodesPermission.Action.READ)

roles

public static RolesPermission roles(String role,
 RolesPermission.Action... actions)

Create RolesPermission for multiple actions.

Example: Permission.roles("MyRole", RolesPermission.Action.READ, RolesPermission.Action.UPDATE)

tenants

public static TenantsPermission tenants(TenantsPermission.Action... actions)

Create TenantsPermission for a tenant.

Example: Permission.tenants(TenantsPermission.Action.READ)

users

public static UsersPermission users(UsersPermission.Action... actions)

Create UsersPermission.

Example: Permission.users(UsersPermission.Action.READ)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object