com.microsoft.azure.cosmosdb

Class Permission

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmosdb.Permission

public class Permission
extends Resource

Represents a per-User Permission to access a specific resource e.g. Document or Collection in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Constructor and Description
Permission() Initialize a permission object.
Permission(String jsonString) Initialize a permission object from json string.

Method Summary

Modifier and Type	Method and Description
PermissionMode	getPermissionMode() Gets the permission mode.
String	getResourceLink() Gets the self-link of resource to which the permission applies.
PartitionKey	getResourcePartitionKey() Gets the resource partition key associated with this permission object.
String	getToken() Gets the access token granting the defined permission.
void	setPermissionMode(PermissionMode permissionMode) Sets the permission mode.
void	setResourceLink(String resourceLink) Sets the self-link of resource to which the permission applies.
void	setResourcePartitionKey(PartitionKey partitionkey) Sets the resource partition key associated with this permission object.

Methods inherited from class com.microsoft.azure.cosmosdb.Resource

getETag, getId, getResourceId, getSelfLink, getTimestamp, setId, setResourceId

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getList, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Permission

public Permission()

Initialize a permission object.

Permission

public Permission(String jsonString)

Initialize a permission object from json string.

Parameters:

jsonString - the json string that represents the permission.

Method Detail

getResourceLink

public String getResourceLink()

Gets the self-link of resource to which the permission applies.

Returns:

the resource link.

setResourceLink

public void setResourceLink(String resourceLink)

Sets the self-link of resource to which the permission applies.

Parameters:

resourceLink - the resource link.

getPermissionMode

public PermissionMode getPermissionMode()

Gets the permission mode.

Returns:

the permission mode.

setPermissionMode

public void setPermissionMode(PermissionMode permissionMode)

Sets the permission mode.

Parameters:

permissionMode - the permission mode.

getToken

public String getToken()

Gets the access token granting the defined permission.

Returns:

the access token.

getResourcePartitionKey

public PartitionKey getResourcePartitionKey()

Gets the resource partition key associated with this permission object.

Returns:

the partition key.

setResourcePartitionKey

public void setResourcePartitionKey(PartitionKey partitionkey)

Sets the resource partition key associated with this permission object.

Parameters:

partitionkey - the partition key.