com.google.api.services.drive

Class Drive.Permissions.List

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.drive.DriveRequest<PermissionList>

com.google.api.services.drive.Drive.Permissions.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive.Permissions

public class Drive.Permissions.List
extends DriveRequest<PermissionList>

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

Modifier	Constructor and Description
protected	Drive.Permissions.List(String fileId) Lists a file's or Team Drive's permissions.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getFileId() The ID for the file or Team Drive.
Integer	getMaxResults() The maximum number of permissions to return per page.
String	getPageToken() The token for continuing a previous list request on the next page.
Boolean	getSupportsTeamDrives() Whether the requesting application supports Team Drives.
Boolean	getUseDomainAdminAccess() Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUseDomainAdminAccess() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Permissions.List	set(String parameterName, Object value)
Drive.Permissions.List	setAlt(String alt) Data format for the response.
Drive.Permissions.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Drive.Permissions.List	setFileId(String fileId) The ID for the file or Team Drive.
Drive.Permissions.List	setKey(String key) API key.
Drive.Permissions.List	setMaxResults(Integer maxResults) The maximum number of permissions to return per page.
Drive.Permissions.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Permissions.List	setPageToken(String pageToken) The token for continuing a previous list request on the next page.
Drive.Permissions.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Permissions.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Drive.Permissions.List	setSupportsTeamDrives(Boolean supportsTeamDrives) Whether the requesting application supports Team Drives.
Drive.Permissions.List	setUseDomainAdminAccess(Boolean useDomainAdminAccess) Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.
Drive.Permissions.List	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.drive.DriveRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

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

Constructor Detail

Drive.Permissions.List

protected Drive.Permissions.List(String fileId)

Lists a file's or Team Drive's permissions. Create a request for the method "permissions.list". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

fileId - The ID for the file or Team Drive.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<PermissionList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<PermissionList>

Throws:

IOException

setAlt

public Drive.Permissions.List setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<PermissionList>

setFields

public Drive.Permissions.List setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DriveRequest<PermissionList>

setKey

public Drive.Permissions.List setKey(String key)

Description copied from class: DriveRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DriveRequest<PermissionList>

setOauthToken

public Drive.Permissions.List setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<PermissionList>

setPrettyPrint

public Drive.Permissions.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<PermissionList>

setQuotaUser

public Drive.Permissions.List setQuotaUser(String quotaUser)

Description copied from class: DriveRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class DriveRequest<PermissionList>

setUserIp

public Drive.Permissions.List setUserIp(String userIp)

Description copied from class: DriveRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class DriveRequest<PermissionList>

getFileId

public String getFileId()

The ID for the file or Team Drive.

setFileId

public Drive.Permissions.List setFileId(String fileId)

The ID for the file or Team Drive.

getMaxResults

public Integer getMaxResults()

The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned. [minimum: 1] [maximum: 100]

setMaxResults

public Drive.Permissions.List setMaxResults(Integer maxResults)

The maximum number of permissions to return per page. When not set for files in a Team Drive, at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire list will be returned.

getPageToken

public String getPageToken()

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

setPageToken

public Drive.Permissions.List setPageToken(String pageToken)

The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Whether the requesting application supports Team Drives. [default: false]

setSupportsTeamDrives

public Drive.Permissions.List setSupportsTeamDrives(Boolean supportsTeamDrives)

Whether the requesting application supports Team Drives.

isSupportsTeamDrives

public boolean isSupportsTeamDrives()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether the requesting application supports Team Drives.

getUseDomainAdminAccess

public Boolean getUseDomainAdminAccess()

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs. [default: false]

setUseDomainAdminAccess

public Drive.Permissions.List setUseDomainAdminAccess(Boolean useDomainAdminAccess)

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.

isUseDomainAdminAccess

public boolean isUseDomainAdminAccess()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether the request should be treated as if it was issued by a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the item belongs.

set

public Drive.Permissions.List set(String parameterName,
                         Object value)

Overrides:

set in class DriveRequest<PermissionList>