Drive (Drive API v3 (Rev. 197) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.drive.model.Drive

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Drive
extends com.google.api.client.json.GenericJson
```
Representation of a shared drive.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Drive API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Drive.BackgroundImageFile` An image file and cropping parameters from which a background image for this shared drive is set.
`static class`	`Drive.Capabilities` Capabilities the current user has on this shared drive.
`static class`	`Drive.Restrictions` A set of restrictions that apply to this shared drive or items inside this shared drive.

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
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

Constructor Summary

Constructors
Constructor and Description

Drive()

Constructors
Constructor and Description
`Drive()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Drive`	`clone()`
`Drive.BackgroundImageFile`	`getBackgroundImageFile()` An image file and cropping parameters from which a background image for this shared drive is set.
`java.lang.String`	`getBackgroundImageLink()` A short-lived link to this shared drive's background image.
`Drive.Capabilities`	`getCapabilities()` Capabilities the current user has on this shared drive.
`java.lang.String`	`getColorRgb()` The color of this shared drive as an RGB hex string.
`com.google.api.client.util.DateTime`	`getCreatedTime()` The time at which the shared drive was created (RFC 3339 date-time).
`java.lang.Boolean`	`getHidden()` Whether the shared drive is hidden from default view.
`java.lang.String`	`getId()` The ID of this shared drive which is also the ID of the top level folder of this shared drive.
`java.lang.String`	`getKind()` Identifies what kind of resource this is.
`java.lang.String`	`getName()` The name of this shared drive.
`Drive.Restrictions`	`getRestrictions()` A set of restrictions that apply to this shared drive or items inside this shared drive.
`java.lang.String`	`getThemeId()` The ID of the theme from which the background image and color will be set.
`Drive`	`set(java.lang.String fieldName, java.lang.Object value)`
`Drive`	`setBackgroundImageFile(Drive.BackgroundImageFile backgroundImageFile)` An image file and cropping parameters from which a background image for this shared drive is set.
`Drive`	`setBackgroundImageLink(java.lang.String backgroundImageLink)` A short-lived link to this shared drive's background image.
`Drive`	`setCapabilities(Drive.Capabilities capabilities)` Capabilities the current user has on this shared drive.
`Drive`	`setColorRgb(java.lang.String colorRgb)` The color of this shared drive as an RGB hex string.
`Drive`	`setCreatedTime(com.google.api.client.util.DateTime createdTime)` The time at which the shared drive was created (RFC 3339 date-time).
`Drive`	`setHidden(java.lang.Boolean hidden)` Whether the shared drive is hidden from default view.
`Drive`	`setId(java.lang.String id)` The ID of this shared drive which is also the ID of the top level folder of this shared drive.
`Drive`	`setKind(java.lang.String kind)` Identifies what kind of resource this is.
`Drive`	`setName(java.lang.String name)` The name of this shared drive.
`Drive`	`setRestrictions(Drive.Restrictions restrictions)` A set of restrictions that apply to this shared drive or items inside this shared drive.
`Drive`	`setThemeId(java.lang.String themeId)` The ID of the theme from which the background image and color will be set.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - Drive
```
public Drive()
```
- Method Detail
  - getBackgroundImageFile
```
public Drive.BackgroundImageFile getBackgroundImageFile()
```
    An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
    
    Returns:
    
    value or null for none
  - setBackgroundImageFile
```
public Drive setBackgroundImageFile(Drive.BackgroundImageFile backgroundImageFile)
```
    An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
    
    Parameters:
    
    backgroundImageFile - backgroundImageFile or null for none
  - getBackgroundImageLink
```
public java.lang.String getBackgroundImageLink()
```
    A short-lived link to this shared drive's background image.
    
    Returns:
    
    value or null for none
  - setBackgroundImageLink
```
public Drive setBackgroundImageLink(java.lang.String backgroundImageLink)
```
    A short-lived link to this shared drive's background image.
    
    Parameters:
    
    backgroundImageLink - backgroundImageLink or null for none
  - getCapabilities
```
public Drive.Capabilities getCapabilities()
```
    Capabilities the current user has on this shared drive.
    
    Returns:
    
    value or null for none
  - setCapabilities
```
public Drive setCapabilities(Drive.Capabilities capabilities)
```
    Capabilities the current user has on this shared drive.
    
    Parameters:
    
    capabilities - capabilities or null for none
  - getColorRgb
```
public java.lang.String getColorRgb()
```
    The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.
    
    Returns:
    
    value or null for none
  - setColorRgb
```
public Drive setColorRgb(java.lang.String colorRgb)
```
    The color of this shared drive as an RGB hex string. It can only be set on a drive.drives.update request that does not set themeId.
    
    Parameters:
    
    colorRgb - colorRgb or null for none
  - getCreatedTime
```
public com.google.api.client.util.DateTime getCreatedTime()
```
    The time at which the shared drive was created (RFC 3339 date-time).
    
    Returns:
    
    value or null for none
  - setCreatedTime
```
public Drive setCreatedTime(com.google.api.client.util.DateTime createdTime)
```
    The time at which the shared drive was created (RFC 3339 date-time).
    
    Parameters:
    
    createdTime - createdTime or null for none
  - getHidden
```
public java.lang.Boolean getHidden()
```
    Whether the shared drive is hidden from default view.
    
    Returns:
    
    value or null for none
  - setHidden
```
public Drive setHidden(java.lang.Boolean hidden)
```
    Whether the shared drive is hidden from default view.
    
    Parameters:
    
    hidden - hidden or null for none
  - getId
```
public java.lang.String getId()
```
    The ID of this shared drive which is also the ID of the top level folder of this shared drive.
    
    Returns:
    
    value or null for none
  - setId
```
public Drive setId(java.lang.String id)
```
    The ID of this shared drive which is also the ID of the top level folder of this shared drive.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public java.lang.String getKind()
```
    Identifies what kind of resource this is. Value: the fixed string "drive#drive".
    
    Returns:
    
    value or null for none
  - setKind
```
public Drive setKind(java.lang.String kind)
```
    Identifies what kind of resource this is. Value: the fixed string "drive#drive".
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    The name of this shared drive.
    
    Returns:
    
    value or null for none
  - setName
```
public Drive setName(java.lang.String name)
```
    The name of this shared drive.
    
    Parameters:
    
    name - name or null for none
  - getRestrictions
```
public Drive.Restrictions getRestrictions()
```
    A set of restrictions that apply to this shared drive or items inside this shared drive.
    
    Returns:
    
    value or null for none
  - setRestrictions
```
public Drive setRestrictions(Drive.Restrictions restrictions)
```
    A set of restrictions that apply to this shared drive or items inside this shared drive.
    
    Parameters:
    
    restrictions - restrictions or null for none
  - getThemeId
```
public java.lang.String getThemeId()
```
    The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
    
    Returns:
    
    value or null for none
  - setThemeId
```
public Drive setThemeId(java.lang.String themeId)
```
    The ID of the theme from which the background image and color will be set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
    
    Parameters:
    
    themeId - themeId or null for none
  - set
```
public Drive set(java.lang.String fieldName,
                 java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Drive clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Drive API v3 (revision 197)

Class Drive

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Drive

Method Detail

getBackgroundImageFile

setBackgroundImageFile

getBackgroundImageLink

setBackgroundImageLink

getCapabilities

setCapabilities

getColorRgb

setColorRgb

getCreatedTime

setCreatedTime

getHidden

setHidden

getId

setId

getKind

setKind

getName

setName

getRestrictions

setRestrictions

getThemeId

setThemeId

set

clone