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

Class PositionedObject

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as 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

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

Method Summary

Modifier and Type	Method and Description
PositionedObject	clone()
String	getObjectId() The ID of this positioned object.
PositionedObjectProperties	getPositionedObjectProperties() The properties of this positioned object.
List<String>	getSuggestedDeletionIds() The suggested deletion IDs.
String	getSuggestedInsertionId() The suggested insertion ID.
Map<String,SuggestedPositionedObjectProperties>	getSuggestedPositionedObjectPropertiesChanges() The suggested changes to the positioned object properties, keyed by suggestion ID.
PositionedObject	set(String fieldName, Object value)
PositionedObject	setObjectId(String objectId) The ID of this positioned object.
PositionedObject	setPositionedObjectProperties(PositionedObjectProperties positionedObjectProperties) The properties of this positioned object.
PositionedObject	setSuggestedDeletionIds(List<String> suggestedDeletionIds) The suggested deletion IDs.
PositionedObject	setSuggestedInsertionId(String suggestedInsertionId) The suggested insertion ID.
PositionedObject	setSuggestedPositionedObjectPropertiesChanges(Map<String,SuggestedPositionedObjectProperties> suggestedPositionedObjectPropertiesChanges) The suggested changes to the positioned object properties, keyed by suggestion ID.

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

PositionedObject

public PositionedObject()

Method Detail

getObjectId

public String getObjectId()

The ID of this positioned object.

Returns:

value or null for none

setObjectId

public PositionedObject setObjectId(String objectId)

The ID of this positioned object.

Parameters:

objectId - objectId or null for none

getPositionedObjectProperties

public PositionedObjectProperties getPositionedObjectProperties()

The properties of this positioned object.

Returns:

value or null for none

setPositionedObjectProperties

public PositionedObject setPositionedObjectProperties(PositionedObjectProperties positionedObjectProperties)

The properties of this positioned object.

Parameters:

positionedObjectProperties - positionedObjectProperties or null for none

getSuggestedDeletionIds

public List<String> getSuggestedDeletionIds()

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Returns:

value or null for none

setSuggestedDeletionIds

public PositionedObject setSuggestedDeletionIds(List<String> suggestedDeletionIds)

The suggested deletion IDs. If empty, then there are no suggested deletions of this content.

Parameters:

suggestedDeletionIds - suggestedDeletionIds or null for none

getSuggestedInsertionId

public String getSuggestedInsertionId()

The suggested insertion ID. If empty, then this is not a suggested insertion.

Returns:

value or null for none

setSuggestedInsertionId

public PositionedObject setSuggestedInsertionId(String suggestedInsertionId)

The suggested insertion ID. If empty, then this is not a suggested insertion.

Parameters:

suggestedInsertionId - suggestedInsertionId or null for none

getSuggestedPositionedObjectPropertiesChanges

public Map<String,SuggestedPositionedObjectProperties> getSuggestedPositionedObjectPropertiesChanges()

The suggested changes to the positioned object properties, keyed by suggestion ID.

Returns:

value or null for none

setSuggestedPositionedObjectPropertiesChanges

public PositionedObject setSuggestedPositionedObjectPropertiesChanges(Map<String,SuggestedPositionedObjectProperties> suggestedPositionedObjectPropertiesChanges)

The suggested changes to the positioned object properties, keyed by suggestion ID.

Parameters:

suggestedPositionedObjectPropertiesChanges - suggestedPositionedObjectPropertiesChanges or null for none

set

public PositionedObject set(String fieldName,
                            Object value)

Overrides:

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

clone

public PositionedObject clone()

Overrides:

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