Permission (Drive API v3 (Rev. 159) 1.22.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.drive.model.Permission

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Permission
extends com.google.api.client.json.GenericJson
```
A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Drive API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Permission.TeamDrivePermissionDetails
Model definition for PermissionTeamDrivePermissionDetails.
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Nested Classes
Modifier and Type	Class and Description
`static class`	`Permission.TeamDrivePermissionDetails` Model definition for PermissionTeamDrivePermissionDetails.

Constructor Summary

Constructors
Constructor and Description

Permission()

Constructors
Constructor and Description
`Permission()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Permission`	`clone()`
`java.lang.Boolean`	`getAllowFileDiscovery()` Whether the permission allows the file to be discovered through search.
`java.lang.Boolean`	`getDeleted()` Whether the account associated with this permission has been deleted.
`java.lang.String`	`getDisplayName()` A displayable name for users, groups or domains.
`java.lang.String`	`getDomain()` The domain to which this permission refers.
`java.lang.String`	`getEmailAddress()` The email address of the user or group to which this permission refers.
`com.google.api.client.util.DateTime`	`getExpirationTime()` The time at which this permission will expire (RFC 3339 date-time).
`java.lang.String`	`getId()` The ID of this permission.
`java.lang.String`	`getKind()` Identifies what kind of resource this is.
`java.lang.String`	`getPhotoLink()` A link to the user's profile photo, if available.
`java.lang.String`	`getRole()` The role granted by this permission.
`java.util.List<Permission.TeamDrivePermissionDetails>`	`getTeamDrivePermissionDetails()` Details of whether the permissions on this Team Drive item are inherited or directly on this item.
`java.lang.String`	`getType()` The type of the grantee.
`Permission`	`set(java.lang.String fieldName, java.lang.Object value)`
`Permission`	`setAllowFileDiscovery(java.lang.Boolean allowFileDiscovery)` Whether the permission allows the file to be discovered through search.
`Permission`	`setDeleted(java.lang.Boolean deleted)` Whether the account associated with this permission has been deleted.
`Permission`	`setDisplayName(java.lang.String displayName)` A displayable name for users, groups or domains.
`Permission`	`setDomain(java.lang.String domain)` The domain to which this permission refers.
`Permission`	`setEmailAddress(java.lang.String emailAddress)` The email address of the user or group to which this permission refers.
`Permission`	`setExpirationTime(com.google.api.client.util.DateTime expirationTime)` The time at which this permission will expire (RFC 3339 date-time).
`Permission`	`setId(java.lang.String id)` The ID of this permission.
`Permission`	`setKind(java.lang.String kind)` Identifies what kind of resource this is.
`Permission`	`setPhotoLink(java.lang.String photoLink)` A link to the user's profile photo, if available.
`Permission`	`setRole(java.lang.String role)` The role granted by this permission.
`Permission`	`setTeamDrivePermissionDetails(java.util.List<Permission.TeamDrivePermissionDetails> teamDrivePermissionDetails)` Details of whether the permissions on this Team Drive item are inherited or directly on this item.
`Permission`	`setType(java.lang.String type)` The type of the grantee.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Permission
```
public Permission()
```
- Method Detail
  - getAllowFileDiscovery
```
public java.lang.Boolean getAllowFileDiscovery()
```
    Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
    
    Returns:
    
    value or null for none
  - setAllowFileDiscovery
```
public Permission setAllowFileDiscovery(java.lang.Boolean allowFileDiscovery)
```
    Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
    
    Parameters:
    
    allowFileDiscovery - allowFileDiscovery or null for none
  - getDeleted
```
public java.lang.Boolean getDeleted()
```
    Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
    
    Returns:
    
    value or null for none
  - setDeleted
```
public Permission setDeleted(java.lang.Boolean deleted)
```
    Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
    
    Parameters:
    
    deleted - deleted or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    A displayable name for users, groups or domains.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public Permission setDisplayName(java.lang.String displayName)
```
    A displayable name for users, groups or domains.
    
    Parameters:
    
    displayName - displayName or null for none
  - getDomain
```
public java.lang.String getDomain()
```
    The domain to which this permission refers.
    
    Returns:
    
    value or null for none
  - setDomain
```
public Permission setDomain(java.lang.String domain)
```
    The domain to which this permission refers.
    
    Parameters:
    
    domain - domain or null for none
  - getEmailAddress
```
public java.lang.String getEmailAddress()
```
    The email address of the user or group to which this permission refers.
    
    Returns:
    
    value or null for none
  - setEmailAddress
```
public Permission setEmailAddress(java.lang.String emailAddress)
```
    The email address of the user or group to which this permission refers.
    
    Parameters:
    
    emailAddress - emailAddress or null for none
  - getExpirationTime
```
public com.google.api.client.util.DateTime getExpirationTime()
```
    The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
    
    Returns:
    
    value or null for none
  - setExpirationTime
```
public Permission setExpirationTime(com.google.api.client.util.DateTime expirationTime)
```
    The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future
    
    Parameters:
    
    expirationTime - expirationTime or null for none
  - getId
```
public java.lang.String getId()
```
    The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
    
    Returns:
    
    value or null for none
  - setId
```
public Permission setId(java.lang.String id)
```
    The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string "drive#permission".
    
    Returns:
    
    value or null for none
  - setKind
```
public Permission setKind(java.lang.String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "drive#permission".
    
    Parameters:
    
    kind - kind or null for none
  - getPhotoLink
```
public java.lang.String getPhotoLink()
```
    A link to the user's profile photo, if available.
    
    Returns:
    
    value or null for none
  - setPhotoLink
```
public Permission setPhotoLink(java.lang.String photoLink)
```
    A link to the user's profile photo, if available.
    
    Parameters:
    
    photoLink - photoLink or null for none
  - getRole
```
public java.lang.String getRole()
```
    The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader
    
    Returns:
    
    value or null for none
  - setRole
```
public Permission setRole(java.lang.String role)
```
    The role granted by this permission. While new values may be supported in the future, the following are currently allowed: - owner - organizer - fileOrganizer - writer - commenter - reader
    
    Parameters:
    
    role - role or null for none
  - getTeamDrivePermissionDetails
```
public java.util.List<Permission.TeamDrivePermissionDetails> getTeamDrivePermissionDetails()
```
    Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items.
    
    Returns:
    
    value or null for none
  - setTeamDrivePermissionDetails
```
public Permission setTeamDrivePermissionDetails(java.util.List<Permission.TeamDrivePermissionDetails> teamDrivePermissionDetails)
```
    Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items.
    
    Parameters:
    
    teamDrivePermissionDetails - teamDrivePermissionDetails or null for none
  - getType
```
public java.lang.String getType()
```
    The type of the grantee. Valid values are: - user - group - domain - anyone
    
    Returns:
    
    value or null for none
  - setType
```
public Permission setType(java.lang.String type)
```
    The type of the grantee. Valid values are: - user - group - domain - anyone
    
    Parameters:
    
    type - type or null for none
  - set
```
public Permission set(java.lang.String fieldName,
                      java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Permission clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Drive API v3 (revision 159)

Class Permission

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Permission

Method Detail

getAllowFileDiscovery

setAllowFileDiscovery

getDeleted

setDeleted

getDisplayName

setDisplayName

getDomain

setDomain

getEmailAddress

setEmailAddress

getExpirationTime

setExpirationTime

getId

setId

getKind

setKind

getPhotoLink

setPhotoLink

getRole

setRole

getTeamDrivePermissionDetails

setTeamDrivePermissionDetails

getType

setType

set

clone