com.google.api.services.docs.v1.model

Class ImageProperties

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.docs.v1.model.ImageProperties

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ImageProperties
extends GenericJson

The properties of an image.

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 Google Docs 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/interfaces inherited from class com.google.api.client.util.GenericData

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

Method Summary

Modifier and Type	Method and Description
ImageProperties	clone()
Float	getAngle() The clockwise rotation angle of the image, in radians.
Float	getBrightness() The brightness effect of the image.
String	getContentUri() A URI to the image with a default lifetime of 30 minutes.
Float	getContrast() The contrast effect of the image.
CropProperties	getCropProperties() The crop properties of the image.
String	getSourceUri() The source URI is the URI used to insert the image.
Float	getTransparency() The transparency effect of the image.
ImageProperties	set(String fieldName, Object value)
ImageProperties	setAngle(Float angle) The clockwise rotation angle of the image, in radians.
ImageProperties	setBrightness(Float brightness) The brightness effect of the image.
ImageProperties	setContentUri(String contentUri) A URI to the image with a default lifetime of 30 minutes.
ImageProperties	setContrast(Float contrast) The contrast effect of the image.
ImageProperties	setCropProperties(CropProperties cropProperties) The crop properties of the image.
ImageProperties	setSourceUri(String sourceUri) The source URI is the URI used to insert the image.
ImageProperties	setTransparency(Float transparency) The transparency effect of the 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

ImageProperties

public ImageProperties()

Method Detail

getAngle

public Float getAngle()

The clockwise rotation angle of the image, in radians.

Returns:

value or null for none

setAngle

public ImageProperties setAngle(Float angle)

The clockwise rotation angle of the image, in radians.

Parameters:

angle - angle or null for none

getBrightness

public Float getBrightness()

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

Returns:

value or null for none

setBrightness

public ImageProperties setBrightness(Float brightness)

The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

Parameters:

brightness - brightness or null for none

getContentUri

public String getContentUri()

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

Returns:

value or null for none

setContentUri

public ImageProperties setContentUri(String contentUri)

A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.

Parameters:

contentUri - contentUri or null for none

getContrast

public Float getContrast()

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

Returns:

value or null for none

setContrast

public ImageProperties setContrast(Float contrast)

The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.

Parameters:

contrast - contrast or null for none

getCropProperties

public CropProperties getCropProperties()

The crop properties of the image.

Returns:

value or null for none

setCropProperties

public ImageProperties setCropProperties(CropProperties cropProperties)

The crop properties of the image.

Parameters:

cropProperties - cropProperties or null for none

getSourceUri

public String getSourceUri()

The source URI is the URI used to insert the image. The source URI can be empty.

Returns:

value or null for none

setSourceUri

public ImageProperties setSourceUri(String sourceUri)

The source URI is the URI used to insert the image. The source URI can be empty.

Parameters:

sourceUri - sourceUri or null for none

getTransparency

public Float getTransparency()

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

Returns:

value or null for none

setTransparency

public ImageProperties setTransparency(Float transparency)

The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent.

Parameters:

transparency - transparency or null for none

set

public ImageProperties set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public ImageProperties clone()

Overrides:

clone in class GenericJson