EmbeddedObject (Google Docs API v1-rev20251110-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class EmbeddedObject
extends com.google.api.client.json.GenericJson
```
An embedded object in the document.
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

EmbeddedObject()

Constructors
Constructor and Description
`EmbeddedObject()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EmbeddedObject`	`clone()`
`String`	`getDescription()` The description of the embedded object.
`EmbeddedDrawingProperties`	`getEmbeddedDrawingProperties()` The properties of an embedded drawing.
`EmbeddedObjectBorder`	`getEmbeddedObjectBorder()` The border of the embedded object.
`ImageProperties`	`getImageProperties()` The properties of an image.
`LinkedContentReference`	`getLinkedContentReference()` A reference to the external linked source content.
`Dimension`	`getMarginBottom()` The bottom margin of the embedded object.
`Dimension`	`getMarginLeft()` The left margin of the embedded object.
`Dimension`	`getMarginRight()` The right margin of the embedded object.
`Dimension`	`getMarginTop()` The top margin of the embedded object.
`Size`	`getSize()` The visible size of the image after cropping.
`String`	`getTitle()` The title of the embedded object.
`EmbeddedObject`	`set(String fieldName, Object value)`
`EmbeddedObject`	`setDescription(String description)` The description of the embedded object.
`EmbeddedObject`	`setEmbeddedDrawingProperties(EmbeddedDrawingProperties embeddedDrawingProperties)` The properties of an embedded drawing.
`EmbeddedObject`	`setEmbeddedObjectBorder(EmbeddedObjectBorder embeddedObjectBorder)` The border of the embedded object.
`EmbeddedObject`	`setImageProperties(ImageProperties imageProperties)` The properties of an image.
`EmbeddedObject`	`setLinkedContentReference(LinkedContentReference linkedContentReference)` A reference to the external linked source content.
`EmbeddedObject`	`setMarginBottom(Dimension marginBottom)` The bottom margin of the embedded object.
`EmbeddedObject`	`setMarginLeft(Dimension marginLeft)` The left margin of the embedded object.
`EmbeddedObject`	`setMarginRight(Dimension marginRight)` The right margin of the embedded object.
`EmbeddedObject`	`setMarginTop(Dimension marginTop)` The top margin of the embedded object.
`EmbeddedObject`	`setSize(Size size)` The visible size of the image after cropping.
`EmbeddedObject`	`setTitle(String title)` The title of the embedded object.

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
  - EmbeddedObject
```
public EmbeddedObject()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
    The description of the embedded object. The `title` and `description` are both combined to display alt text.
    
    Returns:
    
    value or null for none
  - setDescription
```
public EmbeddedObject setDescription(String description)
```
    The description of the embedded object. The `title` and `description` are both combined to display alt text.
    
    Parameters:
    
    description - description or null for none
  - getEmbeddedDrawingProperties
```
public EmbeddedDrawingProperties getEmbeddedDrawingProperties()
```
    The properties of an embedded drawing.
    
    Returns:
    
    value or null for none
  - setEmbeddedDrawingProperties
```
public EmbeddedObject setEmbeddedDrawingProperties(EmbeddedDrawingProperties embeddedDrawingProperties)
```
    The properties of an embedded drawing.
    
    Parameters:
    
    embeddedDrawingProperties - embeddedDrawingProperties or null for none
  - getEmbeddedObjectBorder
```
public EmbeddedObjectBorder getEmbeddedObjectBorder()
```
    The border of the embedded object.
    
    Returns:
    
    value or null for none
  - setEmbeddedObjectBorder
```
public EmbeddedObject setEmbeddedObjectBorder(EmbeddedObjectBorder embeddedObjectBorder)
```
    The border of the embedded object.
    
    Parameters:
    
    embeddedObjectBorder - embeddedObjectBorder or null for none
  - getImageProperties
```
public ImageProperties getImageProperties()
```
    The properties of an image.
    
    Returns:
    
    value or null for none
  - setImageProperties
```
public EmbeddedObject setImageProperties(ImageProperties imageProperties)
```
    The properties of an image.
    
    Parameters:
    
    imageProperties - imageProperties or null for none
  - getLinkedContentReference
```
public LinkedContentReference getLinkedContentReference()
```
    A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
    
    Returns:
    
    value or null for none
  - setLinkedContentReference
```
public EmbeddedObject setLinkedContentReference(LinkedContentReference linkedContentReference)
```
    A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
    
    Parameters:
    
    linkedContentReference - linkedContentReference or null for none
  - getMarginBottom
```
public Dimension getMarginBottom()
```
    The bottom margin of the embedded object.
    
    Returns:
    
    value or null for none
  - setMarginBottom
```
public EmbeddedObject setMarginBottom(Dimension marginBottom)
```
    The bottom margin of the embedded object.
    
    Parameters:
    
    marginBottom - marginBottom or null for none
  - getMarginLeft
```
public Dimension getMarginLeft()
```
    The left margin of the embedded object.
    
    Returns:
    
    value or null for none
  - setMarginLeft
```
public EmbeddedObject setMarginLeft(Dimension marginLeft)
```
    The left margin of the embedded object.
    
    Parameters:
    
    marginLeft - marginLeft or null for none
  - getMarginRight
```
public Dimension getMarginRight()
```
    The right margin of the embedded object.
    
    Returns:
    
    value or null for none
  - setMarginRight
```
public EmbeddedObject setMarginRight(Dimension marginRight)
```
    The right margin of the embedded object.
    
    Parameters:
    
    marginRight - marginRight or null for none
  - getMarginTop
```
public Dimension getMarginTop()
```
    The top margin of the embedded object.
    
    Returns:
    
    value or null for none
  - setMarginTop
```
public EmbeddedObject setMarginTop(Dimension marginTop)
```
    The top margin of the embedded object.
    
    Parameters:
    
    marginTop - marginTop or null for none
  - getSize
```
public Size getSize()
```
    The visible size of the image after cropping.
    
    Returns:
    
    value or null for none
  - setSize
```
public EmbeddedObject setSize(Size size)
```
    The visible size of the image after cropping.
    
    Parameters:
    
    size - size or null for none
  - getTitle
```
public String getTitle()
```
    The title of the embedded object. The `title` and `description` are both combined to display alt text.
    
    Returns:
    
    value or null for none
  - setTitle
```
public EmbeddedObject setTitle(String title)
```
    The title of the embedded object. The `title` and `description` are both combined to display alt text.
    
    Parameters:
    
    title - title or null for none
  - set
```
public EmbeddedObject set(String fieldName,
                          Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public EmbeddedObject clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class EmbeddedObject

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

EmbeddedObject

Method Detail

getDescription

setDescription

getEmbeddedDrawingProperties

setEmbeddedDrawingProperties

getEmbeddedObjectBorder

setEmbeddedObjectBorder

getImageProperties

setImageProperties

getLinkedContentReference

setLinkedContentReference

getMarginBottom

setMarginBottom

getMarginLeft

setMarginLeft

getMarginRight

setMarginRight

getMarginTop

setMarginTop

getSize

setSize

getTitle

setTitle

set

clone