target.apidocs.com.google.api.services.drive.Drive.Permissions.Patch.html Maven / Gradle / Ivy
Drive.Permissions.Patch (Drive API v2-rev20180830-1.26.0)
com.google.api.services.drive
Class Drive.Permissions.Patch
- 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<Permission>
-
- com.google.api.services.drive.Drive.Permissions.Patch
-
- Enclosing class:
- Drive.Permissions
public class Drive.Permissions.Patch
extends DriveRequest<Permission>
-
-
Nested Class Summary
-
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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Patch(String fileId,
String permissionId,
Permission content)
Updates a permission using patch semantics.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getFileId()
The ID for the file or Team Drive.
String
getPermissionId()
The ID for the permission.
Boolean
getRemoveExpiration()
Whether to remove the expiration date.
Boolean
getSupportsTeamDrives()
Whether the requesting application supports Team Drives.
Boolean
getTransferOwnership()
Whether changing a role to 'owner' downgrades the current owners to writers.
Boolean
getUseDomainAdminAccess()
Issue the request as 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
isRemoveExpiration()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isSupportsTeamDrives()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isTransferOwnership()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isUseDomainAdminAccess()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
Drive.Permissions.Patch
set(String parameterName,
Object value)
Drive.Permissions.Patch
setAlt(String alt)
Data format for the response.
Drive.Permissions.Patch
setFields(String fields)
Selector specifying which fields to include in a partial response.
Drive.Permissions.Patch
setFileId(String fileId)
The ID for the file or Team Drive.
Drive.Permissions.Patch
setKey(String key)
API key.
Drive.Permissions.Patch
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Drive.Permissions.Patch
setPermissionId(String permissionId)
The ID for the permission.
Drive.Permissions.Patch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Permissions.Patch
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Drive.Permissions.Patch
setRemoveExpiration(Boolean removeExpiration)
Whether to remove the expiration date.
Drive.Permissions.Patch
setSupportsTeamDrives(Boolean supportsTeamDrives)
Whether the requesting application supports Team Drives.
Drive.Permissions.Patch
setTransferOwnership(Boolean transferOwnership)
Whether changing a role to 'owner' downgrades the current owners to writers.
Drive.Permissions.Patch
setUseDomainAdminAccess(Boolean useDomainAdminAccess)
Issue the request as 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.Patch
setUserIp(String userIp)
Deprecated.
-
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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Patch
protected Patch(String fileId,
String permissionId,
Permission content)
Updates a permission using patch semantics.
Create a request for the method "permissions.patch".
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.
permissionId
- The ID for the permission.
content
- the Permission
- Since:
- 1.13
-
Method Detail
-
setAlt
public Drive.Permissions.Patch setAlt(String alt)
Description copied from class: DriveRequest
Data format for the response.
- Overrides:
setAlt
in class DriveRequest<Permission>
-
setFields
public Drive.Permissions.Patch setFields(String fields)
Description copied from class: DriveRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class DriveRequest<Permission>
-
setKey
public Drive.Permissions.Patch 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<Permission>
-
setOauthToken
public Drive.Permissions.Patch setOauthToken(String oauthToken)
Description copied from class: DriveRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class DriveRequest<Permission>
-
setPrettyPrint
public Drive.Permissions.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: DriveRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class DriveRequest<Permission>
-
setQuotaUser
public Drive.Permissions.Patch setQuotaUser(String quotaUser)
Description copied from class: DriveRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- Overrides:
setQuotaUser
in class DriveRequest<Permission>
-
setUserIp
public Drive.Permissions.Patch setUserIp(String userIp)
Description copied from class: DriveRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class DriveRequest<Permission>
-
getFileId
public String getFileId()
The ID for the file or Team Drive.
-
setFileId
public Drive.Permissions.Patch setFileId(String fileId)
The ID for the file or Team Drive.
-
getPermissionId
public String getPermissionId()
The ID for the permission.
-
setPermissionId
public Drive.Permissions.Patch setPermissionId(String permissionId)
The ID for the permission.
-
getRemoveExpiration
public Boolean getRemoveExpiration()
Whether to remove the expiration date. [default: false]
-
setRemoveExpiration
public Drive.Permissions.Patch setRemoveExpiration(Boolean removeExpiration)
Whether to remove the expiration date.
-
isRemoveExpiration
public boolean isRemoveExpiration()
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 to remove the expiration date.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Whether the requesting application supports Team Drives. [default: false]
-
setSupportsTeamDrives
public Drive.Permissions.Patch 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.
-
getTransferOwnership
public Boolean getTransferOwnership()
Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the
specified role is not 'owner'. [default: false]
-
setTransferOwnership
public Drive.Permissions.Patch setTransferOwnership(Boolean transferOwnership)
Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing
if the specified role is not 'owner'.
-
isTransferOwnership
public boolean isTransferOwnership()
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 changing a role to 'owner' downgrades the current owners to writers. Does nothing if the
specified role is not 'owner'.
-
getUseDomainAdminAccess
public Boolean getUseDomainAdminAccess()
Issue the request as 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.Patch setUseDomainAdminAccess(Boolean useDomainAdminAccess)
Issue the request as 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
.
Issue the request as 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.Patch set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<Permission>
Copyright © 2011–2018 Google. All rights reserved.