public class Drive.Permissions.Insert extends DriveRequest<Permission>
com.google.api.client.util.GenericData.Flags
Modifier | Constructor and Description |
---|---|
protected |
Insert(java.lang.String fileId,
Permission content)
Inserts a permission for a file or shared drive.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getEmailMessage()
A plain text custom message to include in notification emails.
|
java.lang.Boolean |
getEnforceSingleParent()
Set to true to opt in to API behavior that aims for all items to have exactly one parent.
|
java.lang.String |
getFileId()
The ID for the file or shared drive.
|
java.lang.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.
|
java.lang.Boolean |
getSendNotificationEmails()
Whether to send notification emails when sharing to users or groups.
|
java.lang.Boolean |
getSupportsAllDrives()
Deprecated - Whether the requesting application supports both My Drives and shared drives.
|
java.lang.Boolean |
getSupportsTeamDrives()
Deprecated use supportsAllDrives instead.
|
java.lang.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 |
isSendNotificationEmails()
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 |
isUseDomainAdminAccess()
Convenience method that returns only
Boolean.TRUE or Boolean.FALSE . |
Drive.Permissions.Insert |
set(java.lang.String parameterName,
java.lang.Object value) |
Drive.Permissions.Insert |
setAlt(java.lang.String alt)
Data format for the response.
|
Drive.Permissions.Insert |
setEmailMessage(java.lang.String emailMessage)
A plain text custom message to include in notification emails.
|
Drive.Permissions.Insert |
setEnforceSingleParent(java.lang.Boolean enforceSingleParent)
Set to true to opt in to API behavior that aims for all items to have exactly one parent.
|
Drive.Permissions.Insert |
setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.
|
Drive.Permissions.Insert |
setFileId(java.lang.String fileId)
The ID for the file or shared drive.
|
Drive.Permissions.Insert |
setKey(java.lang.String key)
API key.
|
Drive.Permissions.Insert |
setMoveToNewOwnersRoot(java.lang.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.Insert |
setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.
|
Drive.Permissions.Insert |
setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.
|
Drive.Permissions.Insert |
setQuotaUser(java.lang.String quotaUser)
An opaque string that represents a user for quota purposes.
|
Drive.Permissions.Insert |
setSendNotificationEmails(java.lang.Boolean sendNotificationEmails)
Whether to send notification emails when sharing to users or groups.
|
Drive.Permissions.Insert |
setSupportsAllDrives(java.lang.Boolean supportsAllDrives)
Deprecated - Whether the requesting application supports both My Drives and shared drives.
|
Drive.Permissions.Insert |
setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
Deprecated use supportsAllDrives instead.
|
Drive.Permissions.Insert |
setUseDomainAdminAccess(java.lang.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.
|
Drive.Permissions.Insert |
setUserIp(java.lang.String userIp)
Deprecated.
|
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders
getJsonContent, newExceptionOnError, queue
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
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
protected Insert(java.lang.String fileId, Permission content)
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.
fileId
- The ID for the file or shared drive.content
- the Permission
public Drive.Permissions.Insert setAlt(java.lang.String alt)
DriveRequest
setAlt
in class DriveRequest<Permission>
public Drive.Permissions.Insert setFields(java.lang.String fields)
DriveRequest
setFields
in class DriveRequest<Permission>
public Drive.Permissions.Insert setKey(java.lang.String key)
DriveRequest
setKey
in class DriveRequest<Permission>
public Drive.Permissions.Insert setOauthToken(java.lang.String oauthToken)
DriveRequest
setOauthToken
in class DriveRequest<Permission>
public Drive.Permissions.Insert setPrettyPrint(java.lang.Boolean prettyPrint)
DriveRequest
setPrettyPrint
in class DriveRequest<Permission>
public Drive.Permissions.Insert setQuotaUser(java.lang.String quotaUser)
DriveRequest
setQuotaUser
in class DriveRequest<Permission>
public Drive.Permissions.Insert setUserIp(java.lang.String userIp)
DriveRequest
setUserIp
in class DriveRequest<Permission>
public java.lang.String getFileId()
public Drive.Permissions.Insert setFileId(java.lang.String fileId)
public java.lang.String getEmailMessage()
public Drive.Permissions.Insert setEmailMessage(java.lang.String emailMessage)
public java.lang.Boolean getEnforceSingleParent()
public Drive.Permissions.Insert setEnforceSingleParent(java.lang.Boolean enforceSingleParent)
public boolean isEnforceSingleParent()
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
.
Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. See moveToNewOwnersRoot for details.
public java.lang.Boolean getMoveToNewOwnersRoot()
public Drive.Permissions.Insert setMoveToNewOwnersRoot(java.lang.Boolean moveToNewOwnersRoot)
public boolean isMoveToNewOwnersRoot()
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. When 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, when enforceSingleParent=true, parents are not changed. If set to false, when enforceSingleParent=false, existing parents are not changed; however, the file will be added to the new owner's My Drive root folder, unless it is already in the new owner's My Drive.
public java.lang.Boolean getSendNotificationEmails()
public Drive.Permissions.Insert setSendNotificationEmails(java.lang.Boolean sendNotificationEmails)
public boolean isSendNotificationEmails()
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 send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.
public java.lang.Boolean getSupportsAllDrives()
public Drive.Permissions.Insert setSupportsAllDrives(java.lang.Boolean supportsAllDrives)
public boolean isSupportsAllDrives()
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 - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
public java.lang.Boolean getSupportsTeamDrives()
public Drive.Permissions.Insert setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives)
public boolean isSupportsTeamDrives()
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.
public java.lang.Boolean getUseDomainAdminAccess()
public Drive.Permissions.Insert setUseDomainAdminAccess(java.lang.Boolean useDomainAdminAccess)
public boolean isUseDomainAdminAccess()
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.
public Drive.Permissions.Insert set(java.lang.String parameterName, java.lang.Object value)
set
in class DriveRequest<Permission>