Class EntityDefinition

java.lang.Object

co.permify.sdk.model.EntityDefinition

@Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class EntityDefinition
extends Object

The EntityDefinition message provides detailed information about a specific entity.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ATTRIBUTES
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_PERMISSIONS
static final String	JSON_PROPERTY_REFERENCES
static final String	JSON_PROPERTY_RELATIONS

Constructor Summary

Constructors

Constructor	Description
EntityDefinition()

Method Summary

Modifier and Type	Method	Description
EntityDefinition	attributes(Map<String,AttributeDefinition> attributes)
boolean	equals(Object o)	Return true if this EntityDefinition object is equal to o.
Map<String,AttributeDefinition>	getAttributes()	Map of attribute definitions within this entity.
String	getName()	The name of the entity, which follows a specific string pattern and has a maximum byte size.
Map<String,PermissionDefinition>	getPermissions()	Map of permission definitions within this entity.
Map<String,EntityDefinitionReference>	getReferences()	Map of references indicating whether a string pertains to a relation, permission, or attribute.
Map<String,RelationDefinition>	getRelations()	Map of relation definitions within this entity.
int	hashCode()
EntityDefinition	name(String name)
EntityDefinition	permissions(Map<String,PermissionDefinition> permissions)
EntityDefinition	putAttributesItem(String key, AttributeDefinition attributesItem)
EntityDefinition	putPermissionsItem(String key, PermissionDefinition permissionsItem)
EntityDefinition	putReferencesItem(String key, EntityDefinitionReference referencesItem)
EntityDefinition	putRelationsItem(String key, RelationDefinition relationsItem)
EntityDefinition	references(Map<String,EntityDefinitionReference> references)
EntityDefinition	relations(Map<String,RelationDefinition> relations)
void	setAttributes(Map<String,AttributeDefinition> attributes)
void	setName(String name)
void	setPermissions(Map<String,PermissionDefinition> permissions)
void	setReferences(Map<String,EntityDefinitionReference> references)
void	setRelations(Map<String,RelationDefinition> relations)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_RELATIONS

public static final String JSON_PROPERTY_RELATIONS

See Also:

• Constant Field Values

JSON_PROPERTY_PERMISSIONS

public static final String JSON_PROPERTY_PERMISSIONS

See Also:

• Constant Field Values

JSON_PROPERTY_ATTRIBUTES

public static final String JSON_PROPERTY_ATTRIBUTES

See Also:

• Constant Field Values

JSON_PROPERTY_REFERENCES

public static final String JSON_PROPERTY_REFERENCES

See Also:

• Constant Field Values

Constructor Details

EntityDefinition

public EntityDefinition()

Method Details

name

public EntityDefinition name(String name)

getName

@Nullable
public String getName()

The name of the entity, which follows a specific string pattern and has a maximum byte size.

Returns:

name

setName

public void setName(String name)

relations

public EntityDefinition relations(Map<String,RelationDefinition> relations)

putRelationsItem

public EntityDefinition putRelationsItem(String key,
 RelationDefinition relationsItem)

getRelations

@Nullable
public Map<String,RelationDefinition> getRelations()

Map of relation definitions within this entity. The key is the relation name, and the value is the RelationDefinition.

Returns:

relations

setRelations

public void setRelations(Map<String,RelationDefinition> relations)

permissions

public EntityDefinition permissions(Map<String,PermissionDefinition> permissions)

putPermissionsItem

public EntityDefinition putPermissionsItem(String key,
 PermissionDefinition permissionsItem)

getPermissions

@Nullable
public Map<String,PermissionDefinition> getPermissions()

Map of permission definitions within this entity. The key is the permission name, and the value is the PermissionDefinition.

Returns:

permissions

setPermissions

public void setPermissions(Map<String,PermissionDefinition> permissions)

attributes

public EntityDefinition attributes(Map<String,AttributeDefinition> attributes)

putAttributesItem

public EntityDefinition putAttributesItem(String key,
 AttributeDefinition attributesItem)

getAttributes

@Nullable
public Map<String,AttributeDefinition> getAttributes()

Map of attribute definitions within this entity. The key is the attribute name, and the value is the AttributeDefinition.

Returns:

attributes

setAttributes

public void setAttributes(Map<String,AttributeDefinition> attributes)

references

public EntityDefinition references(Map<String,EntityDefinitionReference> references)

putReferencesItem

public EntityDefinition putReferencesItem(String key,
 EntityDefinitionReference referencesItem)

getReferences

@Nullable
public Map<String,EntityDefinitionReference> getReferences()

Map of references indicating whether a string pertains to a relation, permission, or attribute.

Returns:

references

setReferences

public void setReferences(Map<String,EntityDefinitionReference> references)

equals

public boolean equals(Object o)

Return true if this EntityDefinition object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string