target.apidocs.com.google.api.services.drive.model.File.Capabilities.html Maven / Gradle / Ivy
File.Capabilities (Google Drive API v3-rev20240123-2.0.0)
com.google.api.services.drive.model
Class File.Capabilities
- 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.File.Capabilities
-
- Enclosing class:
- File
public static final class File.Capabilities
extends com.google.api.client.json.GenericJson
Output only. Capabilities the current user has on this file. Each capability corresponds to a
fine-grained action that a user may take.
-
-
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
Constructor and Description
Capabilities()
-
Method Summary
-
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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
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
-
-
Method Detail
-
getCanAcceptOwnership
public Boolean getCanAcceptOwnership()
Output only. Whether the current user is the pending owner of the file. Not populated for
shared drive files.
- Returns:
- value or
null
for none
-
setCanAcceptOwnership
public File.Capabilities setCanAcceptOwnership(Boolean canAcceptOwnership)
Output only. Whether the current user is the pending owner of the file. Not populated for
shared drive files.
- Parameters:
canAcceptOwnership
- canAcceptOwnership or null
for none
-
getCanAddChildren
public Boolean getCanAddChildren()
Output only. Whether the current user can add children to this folder. This is always false
when the item is not a folder.
- Returns:
- value or
null
for none
-
setCanAddChildren
public File.Capabilities setCanAddChildren(Boolean canAddChildren)
Output only. Whether the current user can add children to this folder. This is always false
when the item is not a folder.
- Parameters:
canAddChildren
- canAddChildren or null
for none
-
getCanAddFolderFromAnotherDrive
public Boolean getCanAddFolderFromAnotherDrive()
Output only. Whether the current user can add a folder from another drive (different shared
drive or My Drive) to this folder. This is false when the item is not a folder. Only populated
for items in shared drives.
- Returns:
- value or
null
for none
-
setCanAddFolderFromAnotherDrive
public File.Capabilities setCanAddFolderFromAnotherDrive(Boolean canAddFolderFromAnotherDrive)
Output only. Whether the current user can add a folder from another drive (different shared
drive or My Drive) to this folder. This is false when the item is not a folder. Only populated
for items in shared drives.
- Parameters:
canAddFolderFromAnotherDrive
- canAddFolderFromAnotherDrive or null
for none
-
getCanAddMyDriveParent
public Boolean getCanAddMyDriveParent()
Output only. Whether the current user can add a parent for the item without removing an
existing parent in the same request. Not populated for shared drive files.
- Returns:
- value or
null
for none
-
setCanAddMyDriveParent
public File.Capabilities setCanAddMyDriveParent(Boolean canAddMyDriveParent)
Output only. Whether the current user can add a parent for the item without removing an
existing parent in the same request. Not populated for shared drive files.
- Parameters:
canAddMyDriveParent
- canAddMyDriveParent or null
for none
-
getCanChangeCopyRequiresWriterPermission
public Boolean getCanChangeCopyRequiresWriterPermission()
Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction
of this file.
- Returns:
- value or
null
for none
-
setCanChangeCopyRequiresWriterPermission
public File.Capabilities setCanChangeCopyRequiresWriterPermission(Boolean canChangeCopyRequiresWriterPermission)
Output only. Whether the current user can change the `copyRequiresWriterPermission` restriction
of this file.
- Parameters:
canChangeCopyRequiresWriterPermission
- canChangeCopyRequiresWriterPermission or null
for none
-
getCanChangeSecurityUpdateEnabled
public Boolean getCanChangeSecurityUpdateEnabled()
Output only. Whether the current user can change the securityUpdateEnabled field on link share
metadata.
- Returns:
- value or
null
for none
-
setCanChangeSecurityUpdateEnabled
public File.Capabilities setCanChangeSecurityUpdateEnabled(Boolean canChangeSecurityUpdateEnabled)
Output only. Whether the current user can change the securityUpdateEnabled field on link share
metadata.
- Parameters:
canChangeSecurityUpdateEnabled
- canChangeSecurityUpdateEnabled or null
for none
-
getCanChangeViewersCanCopyContent
public Boolean getCanChangeViewersCanCopyContent()
Deprecated: Output only.
- Returns:
- value or
null
for none
-
setCanChangeViewersCanCopyContent
public File.Capabilities setCanChangeViewersCanCopyContent(Boolean canChangeViewersCanCopyContent)
Deprecated: Output only.
- Parameters:
canChangeViewersCanCopyContent
- canChangeViewersCanCopyContent or null
for none
-
getCanComment
public Boolean getCanComment()
Output only. Whether the current user can comment on this file.
- Returns:
- value or
null
for none
-
setCanComment
public File.Capabilities setCanComment(Boolean canComment)
Output only. Whether the current user can comment on this file.
- Parameters:
canComment
- canComment or null
for none
-
getCanCopy
public Boolean getCanCopy()
Output only. Whether the current user can copy this file. For an item in a shared drive,
whether the current user can copy non-folder descendants of this item, or this item itself if
it is not a folder.
- Returns:
- value or
null
for none
-
setCanCopy
public File.Capabilities setCanCopy(Boolean canCopy)
Output only. Whether the current user can copy this file. For an item in a shared drive,
whether the current user can copy non-folder descendants of this item, or this item itself if
it is not a folder.
- Parameters:
canCopy
- canCopy or null
for none
-
getCanDelete
public Boolean getCanDelete()
Output only. Whether the current user can delete this file.
- Returns:
- value or
null
for none
-
setCanDelete
public File.Capabilities setCanDelete(Boolean canDelete)
Output only. Whether the current user can delete this file.
- Parameters:
canDelete
- canDelete or null
for none
-
getCanDeleteChildren
public Boolean getCanDeleteChildren()
Output only. Whether the current user can delete children of this folder. This is false when
the item is not a folder. Only populated for items in shared drives.
- Returns:
- value or
null
for none
-
setCanDeleteChildren
public File.Capabilities setCanDeleteChildren(Boolean canDeleteChildren)
Output only. Whether the current user can delete children of this folder. This is false when
the item is not a folder. Only populated for items in shared drives.
- Parameters:
canDeleteChildren
- canDeleteChildren or null
for none
-
getCanDownload
public Boolean getCanDownload()
Output only. Whether the current user can download this file.
- Returns:
- value or
null
for none
-
setCanDownload
public File.Capabilities setCanDownload(Boolean canDownload)
Output only. Whether the current user can download this file.
- Parameters:
canDownload
- canDownload or null
for none
-
getCanEdit
public Boolean getCanEdit()
Output only. Whether the current user can edit this file. Other factors may limit the type of
changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or
`canModifyContent`.
- Returns:
- value or
null
for none
-
setCanEdit
public File.Capabilities setCanEdit(Boolean canEdit)
Output only. Whether the current user can edit this file. Other factors may limit the type of
changes a user can make to a file. For example, see `canChangeCopyRequiresWriterPermission` or
`canModifyContent`.
- Parameters:
canEdit
- canEdit or null
for none
-
getCanListChildren
public Boolean getCanListChildren()
Output only. Whether the current user can list the children of this folder. This is always
false when the item is not a folder.
- Returns:
- value or
null
for none
-
setCanListChildren
public File.Capabilities setCanListChildren(Boolean canListChildren)
Output only. Whether the current user can list the children of this folder. This is always
false when the item is not a folder.
- Parameters:
canListChildren
- canListChildren or null
for none
-
getCanModifyContent
public Boolean getCanModifyContent()
Output only. Whether the current user can modify the content of this file.
- Returns:
- value or
null
for none
-
setCanModifyContent
public File.Capabilities setCanModifyContent(Boolean canModifyContent)
Output only. Whether the current user can modify the content of this file.
- Parameters:
canModifyContent
- canModifyContent or null
for none
-
getCanModifyContentRestriction
public Boolean getCanModifyContentRestriction()
Deprecated: Output only. Use one of `canModifyEditorContentRestriction`,
`canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
- Returns:
- value or
null
for none
-
setCanModifyContentRestriction
public File.Capabilities setCanModifyContentRestriction(Boolean canModifyContentRestriction)
Deprecated: Output only. Use one of `canModifyEditorContentRestriction`,
`canModifyOwnerContentRestriction` or `canRemoveContentRestriction`.
- Parameters:
canModifyContentRestriction
- canModifyContentRestriction or null
for none
-
getCanModifyEditorContentRestriction
public Boolean getCanModifyEditorContentRestriction()
Output only. Whether the current user can add or modify content restrictions on the file which
are editor restricted.
- Returns:
- value or
null
for none
-
setCanModifyEditorContentRestriction
public File.Capabilities setCanModifyEditorContentRestriction(Boolean canModifyEditorContentRestriction)
Output only. Whether the current user can add or modify content restrictions on the file which
are editor restricted.
- Parameters:
canModifyEditorContentRestriction
- canModifyEditorContentRestriction or null
for none
-
getCanModifyLabels
public Boolean getCanModifyLabels()
Output only. Whether the current user can modify the labels on the file.
- Returns:
- value or
null
for none
-
setCanModifyLabels
public File.Capabilities setCanModifyLabels(Boolean canModifyLabels)
Output only. Whether the current user can modify the labels on the file.
- Parameters:
canModifyLabels
- canModifyLabels or null
for none
-
getCanModifyOwnerContentRestriction
public Boolean getCanModifyOwnerContentRestriction()
Output only. Whether the current user can add or modify content restrictions which are owner
restricted.
- Returns:
- value or
null
for none
-
setCanModifyOwnerContentRestriction
public File.Capabilities setCanModifyOwnerContentRestriction(Boolean canModifyOwnerContentRestriction)
Output only. Whether the current user can add or modify content restrictions which are owner
restricted.
- Parameters:
canModifyOwnerContentRestriction
- canModifyOwnerContentRestriction or null
for none
-
getCanMoveChildrenOutOfDrive
public Boolean getCanMoveChildrenOutOfDrive()
Output only. Whether the current user can move children of this folder outside of the shared
drive. This is false when the item is not a folder. Only populated for items in shared drives.
- Returns:
- value or
null
for none
-
setCanMoveChildrenOutOfDrive
public File.Capabilities setCanMoveChildrenOutOfDrive(Boolean canMoveChildrenOutOfDrive)
Output only. Whether the current user can move children of this folder outside of the shared
drive. This is false when the item is not a folder. Only populated for items in shared drives.
- Parameters:
canMoveChildrenOutOfDrive
- canMoveChildrenOutOfDrive or null
for none
-
getCanMoveChildrenOutOfTeamDrive
public Boolean getCanMoveChildrenOutOfTeamDrive()
Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveChildrenOutOfTeamDrive
public File.Capabilities setCanMoveChildrenOutOfTeamDrive(Boolean canMoveChildrenOutOfTeamDrive)
Deprecated: Output only. Use `canMoveChildrenOutOfDrive` instead.
- Parameters:
canMoveChildrenOutOfTeamDrive
- canMoveChildrenOutOfTeamDrive or null
for none
-
getCanMoveChildrenWithinDrive
public Boolean getCanMoveChildrenWithinDrive()
Output only. Whether the current user can move children of this folder within this drive. This
is false when the item is not a folder. Note that a request to move the child may still fail
depending on the current user's access to the child and to the destination folder.
- Returns:
- value or
null
for none
-
setCanMoveChildrenWithinDrive
public File.Capabilities setCanMoveChildrenWithinDrive(Boolean canMoveChildrenWithinDrive)
Output only. Whether the current user can move children of this folder within this drive. This
is false when the item is not a folder. Note that a request to move the child may still fail
depending on the current user's access to the child and to the destination folder.
- Parameters:
canMoveChildrenWithinDrive
- canMoveChildrenWithinDrive or null
for none
-
getCanMoveChildrenWithinTeamDrive
public Boolean getCanMoveChildrenWithinTeamDrive()
Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveChildrenWithinTeamDrive
public File.Capabilities setCanMoveChildrenWithinTeamDrive(Boolean canMoveChildrenWithinTeamDrive)
Deprecated: Output only. Use `canMoveChildrenWithinDrive` instead.
- Parameters:
canMoveChildrenWithinTeamDrive
- canMoveChildrenWithinTeamDrive or null
for none
-
getCanMoveItemIntoTeamDrive
public Boolean getCanMoveItemIntoTeamDrive()
Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveItemIntoTeamDrive
public File.Capabilities setCanMoveItemIntoTeamDrive(Boolean canMoveItemIntoTeamDrive)
Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
- Parameters:
canMoveItemIntoTeamDrive
- canMoveItemIntoTeamDrive or null
for none
-
getCanMoveItemOutOfDrive
public Boolean getCanMoveItemOutOfDrive()
Output only. Whether the current user can move this item outside of this drive by changing its
parent. Note that a request to change the parent of the item may still fail depending on the
new parent that is being added.
- Returns:
- value or
null
for none
-
setCanMoveItemOutOfDrive
public File.Capabilities setCanMoveItemOutOfDrive(Boolean canMoveItemOutOfDrive)
Output only. Whether the current user can move this item outside of this drive by changing its
parent. Note that a request to change the parent of the item may still fail depending on the
new parent that is being added.
- Parameters:
canMoveItemOutOfDrive
- canMoveItemOutOfDrive or null
for none
-
getCanMoveItemOutOfTeamDrive
public Boolean getCanMoveItemOutOfTeamDrive()
Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveItemOutOfTeamDrive
public File.Capabilities setCanMoveItemOutOfTeamDrive(Boolean canMoveItemOutOfTeamDrive)
Deprecated: Output only. Use `canMoveItemOutOfDrive` instead.
- Parameters:
canMoveItemOutOfTeamDrive
- canMoveItemOutOfTeamDrive or null
for none
-
getCanMoveItemWithinDrive
public Boolean getCanMoveItemWithinDrive()
Output only. Whether the current user can move this item within this drive. Note that a request
to change the parent of the item may still fail depending on the new parent that is being added
and the parent that is being removed.
- Returns:
- value or
null
for none
-
setCanMoveItemWithinDrive
public File.Capabilities setCanMoveItemWithinDrive(Boolean canMoveItemWithinDrive)
Output only. Whether the current user can move this item within this drive. Note that a request
to change the parent of the item may still fail depending on the new parent that is being added
and the parent that is being removed.
- Parameters:
canMoveItemWithinDrive
- canMoveItemWithinDrive or null
for none
-
getCanMoveItemWithinTeamDrive
public Boolean getCanMoveItemWithinTeamDrive()
Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveItemWithinTeamDrive
public File.Capabilities setCanMoveItemWithinTeamDrive(Boolean canMoveItemWithinTeamDrive)
Deprecated: Output only. Use `canMoveItemWithinDrive` instead.
- Parameters:
canMoveItemWithinTeamDrive
- canMoveItemWithinTeamDrive or null
for none
-
getCanMoveTeamDriveItem
public Boolean getCanMoveTeamDriveItem()
Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
- Returns:
- value or
null
for none
-
setCanMoveTeamDriveItem
public File.Capabilities setCanMoveTeamDriveItem(Boolean canMoveTeamDriveItem)
Deprecated: Output only. Use `canMoveItemWithinDrive` or `canMoveItemOutOfDrive` instead.
- Parameters:
canMoveTeamDriveItem
- canMoveTeamDriveItem or null
for none
-
getCanReadDrive
public Boolean getCanReadDrive()
Output only. Whether the current user can read the shared drive to which this file belongs.
Only populated for items in shared drives.
- Returns:
- value or
null
for none
-
setCanReadDrive
public File.Capabilities setCanReadDrive(Boolean canReadDrive)
Output only. Whether the current user can read the shared drive to which this file belongs.
Only populated for items in shared drives.
- Parameters:
canReadDrive
- canReadDrive or null
for none
-
getCanReadLabels
public Boolean getCanReadLabels()
Output only. Whether the current user can read the labels on the file.
- Returns:
- value or
null
for none
-
setCanReadLabels
public File.Capabilities setCanReadLabels(Boolean canReadLabels)
Output only. Whether the current user can read the labels on the file.
- Parameters:
canReadLabels
- canReadLabels or null
for none
-
getCanReadRevisions
public Boolean getCanReadRevisions()
Output only. Whether the current user can read the revisions resource of this file. For a
shared drive item, whether revisions of non-folder descendants of this item, or this item
itself if it is not a folder, can be read.
- Returns:
- value or
null
for none
-
setCanReadRevisions
public File.Capabilities setCanReadRevisions(Boolean canReadRevisions)
Output only. Whether the current user can read the revisions resource of this file. For a
shared drive item, whether revisions of non-folder descendants of this item, or this item
itself if it is not a folder, can be read.
- Parameters:
canReadRevisions
- canReadRevisions or null
for none
-
getCanReadTeamDrive
public Boolean getCanReadTeamDrive()
Deprecated: Output only. Use `canReadDrive` instead.
- Returns:
- value or
null
for none
-
setCanReadTeamDrive
public File.Capabilities setCanReadTeamDrive(Boolean canReadTeamDrive)
Deprecated: Output only. Use `canReadDrive` instead.
- Parameters:
canReadTeamDrive
- canReadTeamDrive or null
for none
-
getCanRemoveChildren
public Boolean getCanRemoveChildren()
Output only. Whether the current user can remove children from this folder. This is always
false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or
`canTrashChildren` instead.
- Returns:
- value or
null
for none
-
setCanRemoveChildren
public File.Capabilities setCanRemoveChildren(Boolean canRemoveChildren)
Output only. Whether the current user can remove children from this folder. This is always
false when the item is not a folder. For a folder in a shared drive, use `canDeleteChildren` or
`canTrashChildren` instead.
- Parameters:
canRemoveChildren
- canRemoveChildren or null
for none
-
getCanRemoveContentRestriction
public Boolean getCanRemoveContentRestriction()
Output only. Whether there is a content restriction on the file that can be removed by the
current user.
- Returns:
- value or
null
for none
-
setCanRemoveContentRestriction
public File.Capabilities setCanRemoveContentRestriction(Boolean canRemoveContentRestriction)
Output only. Whether there is a content restriction on the file that can be removed by the
current user.
- Parameters:
canRemoveContentRestriction
- canRemoveContentRestriction or null
for none
-
getCanRemoveMyDriveParent
public Boolean getCanRemoveMyDriveParent()
Output only. Whether the current user can remove a parent from the item without adding another
parent in the same request. Not populated for shared drive files.
- Returns:
- value or
null
for none
-
setCanRemoveMyDriveParent
public File.Capabilities setCanRemoveMyDriveParent(Boolean canRemoveMyDriveParent)
Output only. Whether the current user can remove a parent from the item without adding another
parent in the same request. Not populated for shared drive files.
- Parameters:
canRemoveMyDriveParent
- canRemoveMyDriveParent or null
for none
-
getCanRename
public Boolean getCanRename()
Output only. Whether the current user can rename this file.
- Returns:
- value or
null
for none
-
setCanRename
public File.Capabilities setCanRename(Boolean canRename)
Output only. Whether the current user can rename this file.
- Parameters:
canRename
- canRename or null
for none
-
getCanShare
public Boolean getCanShare()
Output only. Whether the current user can modify the sharing settings for this file.
- Returns:
- value or
null
for none
-
setCanShare
public File.Capabilities setCanShare(Boolean canShare)
Output only. Whether the current user can modify the sharing settings for this file.
- Parameters:
canShare
- canShare or null
for none
-
getCanTrash
public Boolean getCanTrash()
Output only. Whether the current user can move this file to trash.
- Returns:
- value or
null
for none
-
setCanTrash
public File.Capabilities setCanTrash(Boolean canTrash)
Output only. Whether the current user can move this file to trash.
- Parameters:
canTrash
- canTrash or null
for none
-
getCanTrashChildren
public Boolean getCanTrashChildren()
Output only. Whether the current user can trash children of this folder. This is false when the
item is not a folder. Only populated for items in shared drives.
- Returns:
- value or
null
for none
-
setCanTrashChildren
public File.Capabilities setCanTrashChildren(Boolean canTrashChildren)
Output only. Whether the current user can trash children of this folder. This is false when the
item is not a folder. Only populated for items in shared drives.
- Parameters:
canTrashChildren
- canTrashChildren or null
for none
-
getCanUntrash
public Boolean getCanUntrash()
Output only. Whether the current user can restore this file from trash.
- Returns:
- value or
null
for none
-
setCanUntrash
public File.Capabilities setCanUntrash(Boolean canUntrash)
Output only. Whether the current user can restore this file from trash.
- Parameters:
canUntrash
- canUntrash or null
for none
-
set
public File.Capabilities set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public File.Capabilities clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.