com.google.api.services.drive.model

Class Drive.BackgroundImageFile

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Drive

public static final class Drive.BackgroundImageFile
extends com.google.api.client.json.GenericJson

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.

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
BackgroundImageFile()

Method Summary

Modifier and Type	Method and Description
Drive.BackgroundImageFile	clone()
String	getId() The ID of an image file in Google Drive to use for the background image.
Float	getWidth() The width of the cropped image in the closed range of 0 to 1.
Float	getXCoordinate() The X coordinate of the upper left corner of the cropping area in the background image.
Float	getYCoordinate() The Y coordinate of the upper left corner of the cropping area in the background image.
Drive.BackgroundImageFile	set(String fieldName, Object value)
Drive.BackgroundImageFile	setId(String id) The ID of an image file in Google Drive to use for the background image.
Drive.BackgroundImageFile	setWidth(Float width) The width of the cropped image in the closed range of 0 to 1.
Drive.BackgroundImageFile	setXCoordinate(Float xCoordinate) The X coordinate of the upper left corner of the cropping area in the background image.
Drive.BackgroundImageFile	setYCoordinate(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, 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

BackgroundImageFile

public BackgroundImageFile()

Method Detail

getId

public String getId()

The ID of an image file in Google Drive to use for the background image.

Returns:

value or null for none

setId

public Drive.BackgroundImageFile setId(String id)

The ID of an image file in Google Drive to use for the background image.

Parameters:

id - id or null for none

getWidth

public 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 Drive.BackgroundImageFile setWidth(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 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 Drive.BackgroundImageFile setXCoordinate(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 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 Drive.BackgroundImageFile setYCoordinate(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 Drive.BackgroundImageFile set(String fieldName,
                                     Object value)

Overrides:

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

clone

public Drive.BackgroundImageFile clone()

Overrides:

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