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

Class InsertInlineImageRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class InsertInlineImageRequest
extends com.google.api.client.json.GenericJson

Inserts an InlineObject containing an image at the given location.

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

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

Method Summary

Modifier and Type	Method and Description
InsertInlineImageRequest	clone()
EndOfSegmentLocation	getEndOfSegmentLocation() Inserts the text at the end of a header, footer or the document body.
Location	getLocation() Inserts the image at a specific index in the document.
Size	getObjectSize() The size that the image should appear as in the document.
String	getUri() The image URI.
InsertInlineImageRequest	set(String fieldName, Object value)
InsertInlineImageRequest	setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation) Inserts the text at the end of a header, footer or the document body.
InsertInlineImageRequest	setLocation(Location location) Inserts the image at a specific index in the document.
InsertInlineImageRequest	setObjectSize(Size objectSize) The size that the image should appear as in the document.
InsertInlineImageRequest	setUri(String uri) The image URI.

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

InsertInlineImageRequest

public InsertInlineImageRequest()

Method Detail

getEndOfSegmentLocation

public EndOfSegmentLocation getEndOfSegmentLocation()

Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote.

Returns:

value or null for none

setEndOfSegmentLocation

public InsertInlineImageRequest setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation)

Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote.

Parameters:

endOfSegmentLocation - endOfSegmentLocation or null for none

getLocation

public Location getLocation()

Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation.

Returns:

value or null for none

setLocation

public InsertInlineImageRequest setLocation(Location location)

Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation.

Parameters:

location - location or null for none

getObjectSize

public Size getObjectSize()

The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio.

Returns:

value or null for none

setObjectSize

public InsertInlineImageRequest setObjectSize(Size objectSize)

The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio.

Parameters:

objectSize - objectSize or null for none

getUri

public String getUri()

The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field.

Returns:

value or null for none

setUri

public InsertInlineImageRequest setUri(String uri)

The image URI. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URI must be publicly accessible and at most 2 kB in length. The URI itself is saved with the image, and exposed via the ImageProperties.content_uri field.

Parameters:

uri - uri or null for none

set

public InsertInlineImageRequest set(String fieldName,
                                    Object value)

Overrides:

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

clone

public InsertInlineImageRequest clone()

Overrides:

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