Permission (Drive API v2 (Rev. 310) 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.
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

Methods
Modifier and Type	Method and Description
`Permission`	`clone()`
`java.util.List<java.lang.String>`	`getAdditionalRoles()` Additional roles for this user.
`java.lang.String`	`getAuthKey()` Deprecated.
`java.lang.Boolean`	`getDeleted()` Whether the account associated with this permission has been deleted.
`java.lang.String`	`getDomain()` The domain name of the entity this permission refers to.
`java.lang.String`	`getEmailAddress()` The email address of the user or group this permission refers to.
`java.lang.String`	`getEtag()` The ETag of the permission.
`com.google.api.client.util.DateTime`	`getExpirationDate()` The time at which this permission will expire (RFC 3339 date-time).
`java.lang.String`	`getId()` The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources.
`java.lang.String`	`getKind()` This is always drive#permission.
`java.lang.String`	`getName()` The name for this permission.
`java.lang.String`	`getPhotoLink()` A link to the profile photo, if available.
`java.lang.String`	`getRole()` The primary role for this user.
`java.lang.String`	`getSelfLink()` A link back to 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 account type.
`java.lang.String`	`getValue()` The email address or domain name for the entity.
`java.lang.Boolean`	`getWithLink()` Whether the link is required for this permission.
`Permission`	`set(java.lang.String fieldName, java.lang.Object value)`
`Permission`	`setAdditionalRoles(java.util.List<java.lang.String> additionalRoles)` Additional roles for this user.
`Permission`	`setAuthKey(java.lang.String authKey)` Deprecated.
`Permission`	`setDeleted(java.lang.Boolean deleted)` Whether the account associated with this permission has been deleted.
`Permission`	`setDomain(java.lang.String domain)` The domain name of the entity this permission refers to.
`Permission`	`setEmailAddress(java.lang.String emailAddress)` The email address of the user or group this permission refers to.
`Permission`	`setEtag(java.lang.String etag)` The ETag of the permission.
`Permission`	`setExpirationDate(com.google.api.client.util.DateTime expirationDate)` The time at which this permission will expire (RFC 3339 date-time).
`Permission`	`setId(java.lang.String id)` The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources.
`Permission`	`setKind(java.lang.String kind)` This is always drive#permission.
`Permission`	`setName(java.lang.String name)` The name for this permission.
`Permission`	`setPhotoLink(java.lang.String photoLink)` A link to the profile photo, if available.
`Permission`	`setRole(java.lang.String role)` The primary role for this user.
`Permission`	`setSelfLink(java.lang.String selfLink)` A link back to 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 account type.
`Permission`	`setValue(java.lang.String value)` The email address or domain name for the entity.
`Permission`	`setWithLink(java.lang.Boolean withLink)` Whether the link is required for this permission.

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

- Constructor Detail
  - Permission
```
public Permission()
```
- Method Detail
  - getAdditionalRoles
```
public java.util.List<java.lang.String> getAdditionalRoles()
```
    Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
    
    Returns:
    value or null for none
  - setAdditionalRoles
```
public Permission setAdditionalRoles(java.util.List<java.lang.String> additionalRoles)
```
    Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future.
    
    Parameters:
    additionalRoles - additionalRoles or null for none
  - getAuthKey
```
public java.lang.String getAuthKey()
```
    Deprecated.
    
    Returns:
    value or null for none
  - setAuthKey
```
public Permission setAuthKey(java.lang.String authKey)
```
    Deprecated.
    
    Parameters:
    authKey - authKey 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
  - getDomain
```
public java.lang.String getDomain()
```
    The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
    
    Returns:
    value or null for none
  - setDomain
```
public Permission setDomain(java.lang.String domain)
```
    The domain name of the entity this permission refers to. This is an output-only field which is present when the permission type is user, group or domain.
    
    Parameters:
    domain - domain or null for none
  - getEmailAddress
```
public java.lang.String getEmailAddress()
```
    The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    
    Returns:
    value or null for none
  - setEmailAddress
```
public Permission setEmailAddress(java.lang.String emailAddress)
```
    The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group.
    
    Parameters:
    emailAddress - emailAddress or null for none
  - getEtag
```
public java.lang.String getEtag()
```
    The ETag of the permission.
    
    Returns:
    value or null for none
  - setEtag
```
public Permission setEtag(java.lang.String etag)
```
    The ETag of the permission.
    
    Parameters:
    etag - etag or null for none
  - getExpirationDate
```
public com.google.api.client.util.DateTime getExpirationDate()
```
    The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
    
    Returns:
    value or null for none
  - setExpirationDate
```
public Permission setExpirationDate(com.google.api.client.util.DateTime expirationDate)
```
    The time at which this permission will expire (RFC 3339 date-time). Expiration dates have the following restrictions: - They can only be set on user and group permissions - The date must be in the future - The date cannot be more than a year in the future - The date can only be set on drive.permissions.update or drive.permissions.patch requests
    
    Parameters:
    expirationDate - expirationDate or null for none
  - getId
```
public java.lang.String getId()
```
    The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
    
    Returns:
    value or null for none
  - setId
```
public Permission setId(java.lang.String id)
```
    The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
    
    Parameters:
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    This is always drive#permission.
    
    Returns:
    value or null for none
  - setKind
```
public Permission setKind(java.lang.String kind)
```
    This is always drive#permission.
    
    Parameters:
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    The name for this permission.
    
    Returns:
    value or null for none
  - setName
```
public Permission setName(java.lang.String name)
```
    The name for this permission.
    
    Parameters:
    name - name or null for none
  - getPhotoLink
```
public java.lang.String getPhotoLink()
```
    A link to the profile photo, if available.
    
    Returns:
    value or null for none
  - setPhotoLink
```
public Permission setPhotoLink(java.lang.String photoLink)
```
    A link to the profile photo, if available.
    
    Parameters:
    photoLink - photoLink or null for none
  - getRole
```
public java.lang.String getRole()
```
    The primary role for this user. While new values may be supported in the future, the following are currently allowed: - organizer - owner - reader - writer
    
    Returns:
    value or null for none
  - setRole
```
public Permission setRole(java.lang.String role)
```
    The primary role for this user. While new values may be supported in the future, the following are currently allowed: - organizer - owner - reader - writer
    
    Parameters:
    role - role or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    A link back to this permission.
    
    Returns:
    value or null for none
  - setSelfLink
```
public Permission setSelfLink(java.lang.String selfLink)
```
    A link back to this permission.
    
    Parameters:
    selfLink - selfLink 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 account type. Allowed values are: - user - group - domain - anyone
    
    Returns:
    value or null for none
  - setType
```
public Permission setType(java.lang.String type)
```
    The account type. Allowed values are: - user - group - domain - anyone
    
    Parameters:
    type - type or null for none
  - getValue
```
public java.lang.String getValue()
```
    The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
    
    Returns:
    value or null for none
  - setValue
```
public Permission setValue(java.lang.String value)
```
    The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored.
    
    Parameters:
    value - value or null for none
  - getWithLink
```
public java.lang.Boolean getWithLink()
```
    Whether the link is required for this permission.
    
    Returns:
    value or null for none
  - setWithLink
```
public Permission setWithLink(java.lang.Boolean withLink)
```
    Whether the link is required for this permission.
    
    Parameters:
    withLink - withLink 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 v2 (revision 310)

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

Constructor Detail

Permission

Method Detail

getAdditionalRoles

setAdditionalRoles

getAuthKey

setAuthKey

getDeleted

setDeleted

getDomain

setDomain

getEmailAddress

setEmailAddress

getEtag

setEtag

getExpirationDate

setExpirationDate

getId

setId

getKind

setKind

getName

setName

getPhotoLink

setPhotoLink

getRole

setRole

getSelfLink

setSelfLink

getTeamDrivePermissionDetails

setTeamDrivePermissionDetails

getType

setType

getValue

setValue

getWithLink

setWithLink

set

clone