target.apidocs.com.google.api.services.drive.model.Drive.Restrictions.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-drive Show documentation

There is a newer version: v3-rev20241206-2.0.0

Show newest version







Drive.Restrictions (Google Drive API v3-rev20241027-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.drive.model
Class Drive.Restrictions



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.Drive.Restrictions













All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
Drive




public static final class Drive.Restrictions
extends com.google.api.client.json.GenericJson
A set of restrictions that apply to this shared drive or items inside this shared drive. Note
 that restrictions can't be set when creating a shared drive. To add a restriction, first create a
 shared drive and then use `drives.update` to add restrictions.











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>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Restrictions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Drive.Restrictions
clone() 


Boolean
getAdminManagedRestrictions()
Whether administrative privileges on this shared drive are required to modify restrictions.



Boolean
getCopyRequiresWriterPermission()
Whether the options to copy, print, or download files inside this shared drive, should be
 disabled for readers and commenters.



Boolean
getDomainUsersOnly()
Whether access to this shared drive and items inside this shared drive is restricted to users
 of the domain to which this shared drive belongs.



Boolean
getDriveMembersOnly()
Whether access to items inside this shared drive is restricted to its members.



Boolean
getSharingFoldersRequiresOrganizerPermission()
If true, only users with the organizer role can share folders.



Drive.Restrictions
set(String fieldName,
   Object value) 


Drive.Restrictions
setAdminManagedRestrictions(Boolean adminManagedRestrictions)
Whether administrative privileges on this shared drive are required to modify restrictions.



Drive.Restrictions
setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)
Whether the options to copy, print, or download files inside this shared drive, should be
 disabled for readers and commenters.



Drive.Restrictions
setDomainUsersOnly(Boolean domainUsersOnly)
Whether access to this shared drive and items inside this shared drive is restricted to users
 of the domain to which this shared drive belongs.



Drive.Restrictions
setDriveMembersOnly(Boolean driveMembersOnly)
Whether access to items inside this shared drive is restricted to its members.



Drive.Restrictions
setSharingFoldersRequiresOrganizerPermission(Boolean sharingFoldersRequiresOrganizerPermission)
If true, only users with the organizer role can share folders.







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














Constructor Detail





Restrictions
public Restrictions()









Method Detail





getAdminManagedRestrictions
public Boolean getAdminManagedRestrictions()
Whether administrative privileges on this shared drive are required to modify restrictions.

Returns:
value or null for none








setAdminManagedRestrictions
public Drive.Restrictions setAdminManagedRestrictions(Boolean adminManagedRestrictions)
Whether administrative privileges on this shared drive are required to modify restrictions.

Parameters:
adminManagedRestrictions - adminManagedRestrictions or null for none








getCopyRequiresWriterPermission
public Boolean getCopyRequiresWriterPermission()
Whether the options to copy, print, or download files inside this shared drive, should be
 disabled for readers and commenters. When this restriction is set to `true`, it will override
 the similarly named field to `true` for any file inside this shared drive.

Returns:
value or null for none








setCopyRequiresWriterPermission
public Drive.Restrictions setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)
Whether the options to copy, print, or download files inside this shared drive, should be
 disabled for readers and commenters. When this restriction is set to `true`, it will override
 the similarly named field to `true` for any file inside this shared drive.

Parameters:
copyRequiresWriterPermission - copyRequiresWriterPermission or null for none








getDomainUsersOnly
public Boolean getDomainUsersOnly()
Whether access to this shared drive and items inside this shared drive is restricted to users
 of the domain to which this shared drive belongs. This restriction may be overridden by other
 sharing policies controlled outside of this shared drive.

Returns:
value or null for none








setDomainUsersOnly
public Drive.Restrictions setDomainUsersOnly(Boolean domainUsersOnly)
Whether access to this shared drive and items inside this shared drive is restricted to users
 of the domain to which this shared drive belongs. This restriction may be overridden by other
 sharing policies controlled outside of this shared drive.

Parameters:
domainUsersOnly - domainUsersOnly or null for none








getDriveMembersOnly
public Boolean getDriveMembersOnly()
Whether access to items inside this shared drive is restricted to its members.

Returns:
value or null for none








setDriveMembersOnly
public Drive.Restrictions setDriveMembersOnly(Boolean driveMembersOnly)
Whether access to items inside this shared drive is restricted to its members.

Parameters:
driveMembersOnly - driveMembersOnly or null for none








getSharingFoldersRequiresOrganizerPermission
public Boolean getSharingFoldersRequiresOrganizerPermission()
If true, only users with the organizer role can share folders. If false, users with either the
 organizer role or the file organizer role can share folders.

Returns:
value or null for none








setSharingFoldersRequiresOrganizerPermission
public Drive.Restrictions setSharingFoldersRequiresOrganizerPermission(Boolean sharingFoldersRequiresOrganizerPermission)
If true, only users with the organizer role can share folders. If false, users with either the
 organizer role or the file organizer role can share folders.

Parameters:
sharingFoldersRequiresOrganizerPermission - sharingFoldersRequiresOrganizerPermission or null for none








set
public Drive.Restrictions set(String fieldName,
                              Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public Drive.Restrictions clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`Drive.Restrictions`	`clone()`
`Boolean`	`getAdminManagedRestrictions()` Whether administrative privileges on this shared drive are required to modify restrictions.
`Boolean`	`getCopyRequiresWriterPermission()` Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters.
`Boolean`	`getDomainUsersOnly()` Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs.
`Boolean`	`getDriveMembersOnly()` Whether access to items inside this shared drive is restricted to its members.
`Boolean`	`getSharingFoldersRequiresOrganizerPermission()` If true, only users with the organizer role can share folders.
`Drive.Restrictions`	`set(String fieldName, Object value)`
`Drive.Restrictions`	`setAdminManagedRestrictions(Boolean adminManagedRestrictions)` Whether administrative privileges on this shared drive are required to modify restrictions.
`Drive.Restrictions`	`setCopyRequiresWriterPermission(Boolean copyRequiresWriterPermission)` Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters.
`Drive.Restrictions`	`setDomainUsersOnly(Boolean domainUsersOnly)` Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs.
`Drive.Restrictions`	`setDriveMembersOnly(Boolean driveMembersOnly)` Whether access to items inside this shared drive is restricted to its members.
`Drive.Restrictions`	`setSharingFoldersRequiresOrganizerPermission(Boolean sharingFoldersRequiresOrganizerPermission)` If true, only users with the organizer role can share folders.