TeamDrive.BackgroundImageFile (Drive API v2 (Rev. 393) 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.TeamDrive.BackgroundImageFile

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

TeamDrive
```
public static final class TeamDrive.BackgroundImageFile
extends com.google.api.client.json.GenericJson
```
An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.

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
  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

BackgroundImageFile()

Constructors
Constructor and Description
`BackgroundImageFile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TeamDrive.BackgroundImageFile`	`clone()`
`java.lang.String`	`getId()` The ID of an image file in Drive to use for the background image.
`java.lang.Float`	`getWidth()` The width of the cropped image in the closed range of 0 to 1.
`java.lang.Float`	`getXCoordinate()` The X coordinate of the upper left corner of the cropping area in the background image.
`java.lang.Float`	`getYCoordinate()` The Y coordinate of the upper left corner of the cropping area in the background image.
`TeamDrive.BackgroundImageFile`	`set(java.lang.String fieldName, java.lang.Object value)`
`TeamDrive.BackgroundImageFile`	`setId(java.lang.String id)` The ID of an image file in Drive to use for the background image.
`TeamDrive.BackgroundImageFile`	`setWidth(java.lang.Float width)` The width of the cropped image in the closed range of 0 to 1.
`TeamDrive.BackgroundImageFile`	`setXCoordinate(java.lang.Float xCoordinate)` The X coordinate of the upper left corner of the cropping area in the background image.
`TeamDrive.BackgroundImageFile`	`setYCoordinate(java.lang.Float yCoordinate)` The Y coordinate of the upper left corner of the cropping area in the background image.

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
  - BackgroundImageFile
```
public BackgroundImageFile()
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    The ID of an image file in Drive to use for the background image.
    
    Returns:
    
    value or null for none
  - setId
```
public TeamDrive.BackgroundImageFile setId(java.lang.String id)
```
    The ID of an image file in Drive to use for the background image.
    
    Parameters:
    
    id - id or null for none
  - getWidth
```
public java.lang.Float getWidth()
```
    The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
    
    Returns:
    
    value or null for none
  - setWidth
```
public TeamDrive.BackgroundImageFile setWidth(java.lang.Float width)
```
    The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
    
    Parameters:
    
    width - width or null for none
  - getXCoordinate
```
public java.lang.Float getXCoordinate()
```
    The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
    
    Returns:
    
    value or null for none
  - setXCoordinate
```
public TeamDrive.BackgroundImageFile setXCoordinate(java.lang.Float xCoordinate)
```
    The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
    
    Parameters:
    
    xCoordinate - xCoordinate or null for none
  - getYCoordinate
```
public java.lang.Float getYCoordinate()
```
    The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
    
    Returns:
    
    value or null for none
  - setYCoordinate
```
public TeamDrive.BackgroundImageFile setYCoordinate(java.lang.Float yCoordinate)
```
    The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
    
    Parameters:
    
    yCoordinate - yCoordinate or null for none
  - set
```
public TeamDrive.BackgroundImageFile set(java.lang.String fieldName,
                                         java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public TeamDrive.BackgroundImageFile clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Drive API v2 (revision 393)

Class TeamDrive.BackgroundImageFile

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

BackgroundImageFile

Method Detail

getId

setId

getWidth

setWidth

getXCoordinate

setXCoordinate

getYCoordinate

setYCoordinate

set

clone