Permission (Drive API v2 (Rev. 123) 1.18.0-rc)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Permission
extends 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: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Permission()

Constructors
Constructor and Description
`Permission()`

Method Summary

Methods
Modifier and Type	Method and Description
`Permission`	`clone()`
`List<String>`	`getAdditionalRoles()` Additional roles for this user.
`String`	`getAuthKey()` The authkey parameter required for this permission.
`String`	`getDomain()` The domain name of the entity this permission refers to.
`String`	`getEmailAddress()` The email address of the user this permission refers to.
`String`	`getEtag()` The ETag of the permission.
`String`	`getId()` The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources.
`String`	`getKind()` This is always drive#permission.
`String`	`getName()` The name for this permission.
`String`	`getPhotoLink()` A link to the profile photo, if available.
`String`	`getRole()` The primary role for this user.
`String`	`getSelfLink()` A link back to this permission.
`String`	`getType()` The account type.
`String`	`getValue()` The email address or domain name for the entity.
`Boolean`	`getWithLink()` Whether the link is required for this permission.
`Permission`	`set(String fieldName, Object value)`
`Permission`	`setAdditionalRoles(List<String> additionalRoles)` Additional roles for this user.
`Permission`	`setAuthKey(String authKey)` The authkey parameter required for this permission.
`Permission`	`setDomain(String domain)` The domain name of the entity this permission refers to.
`Permission`	`setEmailAddress(String emailAddress)` The email address of the user this permission refers to.
`Permission`	`setEtag(String etag)` The ETag of the permission.
`Permission`	`setId(String id)` The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources.
`Permission`	`setKind(String kind)` This is always drive#permission.
`Permission`	`setName(String name)` The name for this permission.
`Permission`	`setPhotoLink(String photoLink)` A link to the profile photo, if available.
`Permission`	`setRole(String role)` The primary role for this user.
`Permission`	`setSelfLink(String selfLink)` A link back to this permission.
`Permission`	`setType(String type)` The account type.
`Permission`	`setValue(String value)` The email address or domain name for the entity.
`Permission`	`setWithLink(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 List<String> getAdditionalRoles()
```
    Additional roles for this user. Only commenter is currently allowed.
    
    Returns:
    value or null for none
  - setAdditionalRoles
```
public Permission setAdditionalRoles(List<String> additionalRoles)
```
    Additional roles for this user. Only commenter is currently allowed.
    
    Parameters:
    additionalRoles - additionalRoles or null for none
  - getAuthKey
```
public String getAuthKey()
```
    The authkey parameter required for this permission.
    
    Returns:
    value or null for none
  - setAuthKey
```
public Permission setAuthKey(String authKey)
```
    The authkey parameter required for this permission.
    
    Parameters:
    authKey - authKey or null for none
  - getDomain
```
public 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(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 String getEmailAddress()
```
    The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
    
    Returns:
    value or null for none
  - setEmailAddress
```
public Permission setEmailAddress(String emailAddress)
```
    The email address of the user this permission refers to. This is an output-only field which is present when the permission type is user and the given user's Google+ profile privacy settings allow exposing their email address.
    
    Parameters:
    emailAddress - emailAddress or null for none
  - getEtag
```
public String getEtag()
```
    The ETag of the permission.
    
    Returns:
    value or null for none
  - setEtag
```
public Permission setEtag(String etag)
```
    The ETag of the permission.
    
    Parameters:
    etag - etag or null for none
  - getId
```
public 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.
    
    Returns:
    value or null for none
  - setId
```
public Permission setId(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.
    
    Parameters:
    id - id or null for none
  - getKind
```
public String getKind()
```
    This is always drive#permission.
    
    Returns:
    value or null for none
  - setKind
```
public Permission setKind(String kind)
```
    This is always drive#permission.
    
    Parameters:
    kind - kind or null for none
  - getName
```
public String getName()
```
    The name for this permission.
    
    Returns:
    value or null for none
  - setName
```
public Permission setName(String name)
```
    The name for this permission.
    
    Parameters:
    name - name or null for none
  - getPhotoLink
```
public String getPhotoLink()
```
    A link to the profile photo, if available.
    
    Returns:
    value or null for none
  - setPhotoLink
```
public Permission setPhotoLink(String photoLink)
```
    A link to the profile photo, if available.
    
    Parameters:
    photoLink - photoLink or null for none
  - getRole
```
public String getRole()
```
    The primary role for this user. Allowed values are: - owner - reader - writer
    
    Returns:
    value or null for none
  - setRole
```
public Permission setRole(String role)
```
    The primary role for this user. Allowed values are: - owner - reader - writer
    
    Parameters:
    role - role or null for none
  - getSelfLink
```
public String getSelfLink()
```
    A link back to this permission.
    
    Returns:
    value or null for none
  - setSelfLink
```
public Permission setSelfLink(String selfLink)
```
    A link back to this permission.
    
    Parameters:
    selfLink - selfLink or null for none
  - getType
```
public String getType()
```
    The account type. Allowed values are: - user - group - domain - anyone
    
    Returns:
    value or null for none
  - setType
```
public Permission setType(String type)
```
    The account type. Allowed values are: - user - group - domain - anyone
    
    Parameters:
    type - type or null for none
  - getValue
```
public 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.
    
    Returns:
    value or null for none
  - setValue
```
public Permission setValue(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.
    
    Parameters:
    value - value or null for none
  - getWithLink
```
public Boolean getWithLink()
```
    Whether the link is required for this permission.
    
    Returns:
    value or null for none
  - setWithLink
```
public Permission setWithLink(Boolean withLink)
```
    Whether the link is required for this permission.
    
    Parameters:
    withLink - withLink or null for none
  - set
```
public Permission set(String fieldName,
             Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Permission clone()
```
    Overrides:
    
    clone in class GenericJson

Drive API v2 (revision 123)

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

getDomain

setDomain

getEmailAddress

setEmailAddress

getEtag

setEtag

getId

setId

getKind

setKind

getName

setName

getPhotoLink

setPhotoLink

getRole

setRole

getSelfLink

setSelfLink

getType

setType

getValue

setValue

getWithLink

setWithLink

set

clone