target.apidocs.com.google.api.services.drive.Drive.Permissions.Create.html Maven / Gradle / Ivy
Drive.Permissions.Create (Google Drive API v3-rev20240914-2.0.0)
com.google.api.services.drive
Class Drive.Permissions.Create
- 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.Create
-
- Enclosing class:
- Drive.Permissions
public class Drive.Permissions.Create
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
Create(String fileId,
Permission content)
Creates a permission for a file or shared drive.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getEmailMessage()
A plain text custom message to include in the notification email.
Boolean
getEnforceSingleParent()
Deprecated: See `moveToNewOwnersRoot` for details.
String
getFileId()
The ID of the file or shared drive.
Boolean
getMoveToNewOwnersRoot()
This parameter will only take effect if the item is not in a shared drive and the request is
attempting to transfer the ownership of the item.
Boolean
getSendNotificationEmail()
Whether to send a notification email when sharing to users or groups.
Boolean
getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives.
Boolean
getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead.
Boolean
getTransferOwnership()
Whether to transfer ownership to the specified user and downgrade the current owner to a writer.
Boolean
getUseDomainAdminAccess()
Issue the request as a domain administrator; if set to true, then the requester will be granted
access if the file ID parameter refers to a shared drive and the requester is an administrator of
the domain to which the shared drive belongs.
boolean
isEnforceSingleParent()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isMoveToNewOwnersRoot()
Convenience method that returns only Boolean.TRUE
or Boolean.FALSE
.
boolean
isSupportsAllDrives()
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.Create
set(String parameterName,
Object value)
Drive.Permissions.Create
set$Xgafv(String $Xgafv)
V1 error format.
Drive.Permissions.Create
setAccessToken(String accessToken)
OAuth access token.
Drive.Permissions.Create
setAlt(String alt)
Data format for response.
Drive.Permissions.Create
setCallback(String callback)
JSONP
Drive.Permissions.Create
setEmailMessage(String emailMessage)
A plain text custom message to include in the notification email.
Drive.Permissions.Create
setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: See `moveToNewOwnersRoot` for details.
Drive.Permissions.Create
setFields(String fields)
Selector specifying which fields to include in a partial response.
Drive.Permissions.Create
setFileId(String fileId)
The ID of the file or shared drive.
Drive.Permissions.Create
setKey(String key)
API key.
Drive.Permissions.Create
setMoveToNewOwnersRoot(Boolean moveToNewOwnersRoot)
This parameter will only take effect if the item is not in a shared drive and the request
is attempting to transfer the ownership of the item.
Drive.Permissions.Create
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Drive.Permissions.Create
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Drive.Permissions.Create
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Drive.Permissions.Create
setSendNotificationEmail(Boolean sendNotificationEmail)
Whether to send a notification email when sharing to users or groups.
Drive.Permissions.Create
setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.
Drive.Permissions.Create
setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.
Drive.Permissions.Create
setTransferOwnership(Boolean transferOwnership)
Whether to transfer ownership to the specified user and downgrade the current owner to a
writer.
Drive.Permissions.Create
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Drive.Permissions.Create
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
Drive.Permissions.Create
setUseDomainAdminAccess(Boolean useDomainAdminAccess)
Issue the request as a domain administrator; if set to true, then the requester will be
granted access if the file ID parameter refers to a shared drive and the requester is an
administrator of the domain to which the shared drive belongs.
-
Methods inherited from class com.google.api.services.drive.DriveRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
-
Create
protected Create(String fileId,
Permission content)
Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations
on the same file are not supported; only the last update is applied.
Create a request for the method "permissions.create".
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 of the file or shared drive.
content
- the Permission
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Drive.Permissions.Create set$Xgafv(String $Xgafv)
Description copied from class: DriveRequest
V1 error format.
- Overrides:
set$Xgafv
in class DriveRequest<Permission>
-
setAccessToken
public Drive.Permissions.Create setAccessToken(String accessToken)
Description copied from class: DriveRequest
OAuth access token.
- Overrides:
setAccessToken
in class DriveRequest<Permission>
-
setAlt
public Drive.Permissions.Create setAlt(String alt)
Description copied from class: DriveRequest
Data format for response.
- Overrides:
setAlt
in class DriveRequest<Permission>
-
setCallback
public Drive.Permissions.Create setCallback(String callback)
Description copied from class: DriveRequest
JSONP
- Overrides:
setCallback
in class DriveRequest<Permission>
-
setFields
public Drive.Permissions.Create 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.Create 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.Create 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.Create 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.Create 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:
setQuotaUser
in class DriveRequest<Permission>
-
setUploadType
public Drive.Permissions.Create setUploadType(String uploadType)
Description copied from class: DriveRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class DriveRequest<Permission>
-
setUploadProtocol
public Drive.Permissions.Create setUploadProtocol(String uploadProtocol)
Description copied from class: DriveRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class DriveRequest<Permission>
-
getFileId
public String getFileId()
The ID of the file or shared drive.
-
setFileId
public Drive.Permissions.Create setFileId(String fileId)
The ID of the file or shared drive.
-
getEmailMessage
public String getEmailMessage()
A plain text custom message to include in the notification email.
-
setEmailMessage
public Drive.Permissions.Create setEmailMessage(String emailMessage)
A plain text custom message to include in the notification email.
-
getEnforceSingleParent
public Boolean getEnforceSingleParent()
Deprecated: See `moveToNewOwnersRoot` for details. [default: false]
-
setEnforceSingleParent
public Drive.Permissions.Create setEnforceSingleParent(Boolean enforceSingleParent)
Deprecated: See `moveToNewOwnersRoot` for details.
-
isEnforceSingleParent
public boolean isEnforceSingleParent()
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
.
Deprecated: See `moveToNewOwnersRoot` for details.
-
getMoveToNewOwnersRoot
public Boolean getMoveToNewOwnersRoot()
This parameter will only take effect if the item is not in a shared drive and the request is
attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the
new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not
changed. [default: false]
-
setMoveToNewOwnersRoot
public Drive.Permissions.Create setMoveToNewOwnersRoot(Boolean moveToNewOwnersRoot)
This parameter will only take effect if the item is not in a shared drive and the request
is attempting to transfer the ownership of the item. If set to `true`, the item will be
moved to the new owner's My Drive root folder and all prior parents removed. If set to
`false`, parents are not changed.
-
isMoveToNewOwnersRoot
public boolean isMoveToNewOwnersRoot()
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
.
This parameter will only take effect if the item is not in a shared drive and the request is
attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the
new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not
changed.
-
getSendNotificationEmail
public Boolean getSendNotificationEmail()
Whether to send a notification email when sharing to users or groups. This defaults to true for
users and groups, and is not allowed for other requests. It must not be disabled for ownership
transfers.
-
setSendNotificationEmail
public Drive.Permissions.Create setSendNotificationEmail(Boolean sendNotificationEmail)
Whether to send a notification email when sharing to users or groups. This defaults to true
for users and groups, and is not allowed for other requests. It must not be disabled for
ownership transfers.
-
getSupportsAllDrives
public Boolean getSupportsAllDrives()
Whether the requesting application supports both My Drives and shared drives. [default: false]
-
setSupportsAllDrives
public Drive.Permissions.Create setSupportsAllDrives(Boolean supportsAllDrives)
Whether the requesting application supports both My Drives and shared drives.
-
isSupportsAllDrives
public boolean isSupportsAllDrives()
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 both My Drives and shared drives.
-
getSupportsTeamDrives
public Boolean getSupportsTeamDrives()
Deprecated: Use `supportsAllDrives` instead. [default: false]
-
setSupportsTeamDrives
public Drive.Permissions.Create setSupportsTeamDrives(Boolean supportsTeamDrives)
Deprecated: Use `supportsAllDrives` instead.
-
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
.
Deprecated: Use `supportsAllDrives` instead.
-
getTransferOwnership
public Boolean getTransferOwnership()
Whether to transfer ownership to the specified user and downgrade the current owner to a writer.
This parameter is required as an acknowledgement of the side effect. [default: false]
-
setTransferOwnership
public Drive.Permissions.Create setTransferOwnership(Boolean transferOwnership)
Whether to transfer ownership to the specified user and downgrade the current owner to a
writer. This parameter is required as an acknowledgement of the side effect.
-
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 to transfer ownership to the specified user and downgrade the current owner to a writer.
This parameter is required as an acknowledgement of the side effect.
-
getUseDomainAdminAccess
public Boolean getUseDomainAdminAccess()
Issue the request as a domain administrator; if set to true, then the requester will be granted
access if the file ID parameter refers to a shared drive and the requester is an administrator of
the domain to which the shared drive belongs. [default: false]
-
setUseDomainAdminAccess
public Drive.Permissions.Create setUseDomainAdminAccess(Boolean useDomainAdminAccess)
Issue the request as a domain administrator; if set to true, then the requester will be
granted access if the file ID parameter refers to a shared drive and the requester is an
administrator of the domain to which the shared drive 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 the file ID parameter refers to a shared drive and the requester is an administrator of
the domain to which the shared drive belongs.
-
set
public Drive.Permissions.Create set(String parameterName,
Object value)
- Overrides:
set
in class DriveRequest<Permission>
Copyright © 2011–2024 Google. All rights reserved.