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

Class Document

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A Google Docs 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
Document()

Method Summary

Modifier and Type	Method and Description
Document	clone()
Body	getBody() Output only.
String	getDocumentId() Output only.
DocumentStyle	getDocumentStyle() Output only.
Map<String,Footer>	getFooters() Output only.
Map<String,Footnote>	getFootnotes() Output only.
Map<String,Header>	getHeaders() Output only.
Map<String,InlineObject>	getInlineObjects() Output only.
Map<String,List>	getLists() Output only.
Map<String,NamedRanges>	getNamedRanges() Output only.
NamedStyles	getNamedStyles() Output only.
Map<String,PositionedObject>	getPositionedObjects() Output only.
String	getRevisionId() Output only.
Map<String,SuggestedDocumentStyle>	getSuggestedDocumentStyleChanges() Output only.
Map<String,SuggestedNamedStyles>	getSuggestedNamedStylesChanges() Output only.
String	getSuggestionsViewMode() Output only.
List<Tab>	getTabs() Tabs that are part of a document.
String	getTitle() The title of the document.
Document	set(String fieldName, Object value)
Document	setBody(Body body) Output only.
Document	setDocumentId(String documentId) Output only.
Document	setDocumentStyle(DocumentStyle documentStyle) Output only.
Document	setFooters(Map<String,Footer> footers) Output only.
Document	setFootnotes(Map<String,Footnote> footnotes) Output only.
Document	setHeaders(Map<String,Header> headers) Output only.
Document	setInlineObjects(Map<String,InlineObject> inlineObjects) Output only.
Document	setLists(Map<String,List> lists) Output only.
Document	setNamedRanges(Map<String,NamedRanges> namedRanges) Output only.
Document	setNamedStyles(NamedStyles namedStyles) Output only.
Document	setPositionedObjects(Map<String,PositionedObject> positionedObjects) Output only.
Document	setRevisionId(String revisionId) Output only.
Document	setSuggestedDocumentStyleChanges(Map<String,SuggestedDocumentStyle> suggestedDocumentStyleChanges) Output only.
Document	setSuggestedNamedStylesChanges(Map<String,SuggestedNamedStyles> suggestedNamedStylesChanges) Output only.
Document	setSuggestionsViewMode(String suggestionsViewMode) Output only.
Document	setTabs(List<Tab> tabs) Tabs that are part of a document.
Document	setTitle(String title) The title of the document.

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

Document

public Document()

Method Detail

getBody

public Body getBody()

Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setBody

public Document setBody(Body body)

Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

body - body or null for none

getDocumentId

public String getDocumentId()

Output only. The ID of the document.

Returns:

value or null for none

setDocumentId

public Document setDocumentId(String documentId)

Output only. The ID of the document.

Parameters:

documentId - documentId or null for none

getDocumentStyle

public DocumentStyle getDocumentStyle()

Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setDocumentStyle

public Document setDocumentStyle(DocumentStyle documentStyle)

Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

documentStyle - documentStyle or null for none

getFooters

public Map<String,Footer> getFooters()

Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setFooters

public Document setFooters(Map<String,Footer> footers)

Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

footers - footers or null for none

getFootnotes

public Map<String,Footnote> getFootnotes()

Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setFootnotes

public Document setFootnotes(Map<String,Footnote> footnotes)

Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

footnotes - footnotes or null for none

getHeaders

public Map<String,Header> getHeaders()

Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setHeaders

public Document setHeaders(Map<String,Header> headers)

Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

headers - headers or null for none

getInlineObjects

public Map<String,InlineObject> getInlineObjects()

Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setInlineObjects

public Document setInlineObjects(Map<String,InlineObject> inlineObjects)

Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

inlineObjects - inlineObjects or null for none

getLists

public Map<String,List> getLists()

Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setLists

public Document setLists(Map<String,List> lists)

Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

lists - lists or null for none

getNamedRanges

public Map<String,NamedRanges> getNamedRanges()

Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setNamedRanges

public Document setNamedRanges(Map<String,NamedRanges> namedRanges)

Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

namedRanges - namedRanges or null for none

getNamedStyles

public NamedStyles getNamedStyles()

Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setNamedStyles

public Document setNamedStyles(NamedStyles namedStyles)

Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

namedStyles - namedStyles or null for none

getPositionedObjects

public Map<String,PositionedObject> getPositionedObjects()

Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setPositionedObjects

public Document setPositionedObjects(Map<String,PositionedObject> positionedObjects)

Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

positionedObjects - positionedObjects or null for none

getRevisionId

public String getRevisionId()

Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.

Returns:

value or null for none

setRevisionId

public Document setRevisionId(String revisionId)

Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.

Parameters:

revisionId - revisionId or null for none

getSuggestedDocumentStyleChanges

public Map<String,SuggestedDocumentStyle> getSuggestedDocumentStyleChanges()

Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setSuggestedDocumentStyleChanges

public Document setSuggestedDocumentStyleChanges(Map<String,SuggestedDocumentStyle> suggestedDocumentStyleChanges)

Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

suggestedDocumentStyleChanges - suggestedDocumentStyleChanges or null for none

getSuggestedNamedStylesChanges

public Map<String,SuggestedNamedStyles> getSuggestedNamedStylesChanges()

Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Returns:

value or null for none

setSuggestedNamedStylesChanges

public Document setSuggestedNamedStylesChanges(Map<String,SuggestedNamedStyles> suggestedNamedStylesChanges)

Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.

Parameters:

suggestedNamedStylesChanges - suggestedNamedStylesChanges or null for none

getSuggestionsViewMode

public String getSuggestionsViewMode()

Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.

Returns:

value or null for none

setSuggestionsViewMode

public Document setSuggestionsViewMode(String suggestionsViewMode)

Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.

Parameters:

suggestionsViewMode - suggestionsViewMode or null for none

getTabs

public List<Tab> getTabs()

Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.

Returns:

value or null for none

setTabs

public Document setTabs(List<Tab> tabs)

Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.

Parameters:

tabs - tabs or null for none

getTitle

public String getTitle()

The title of the document.

Returns:

value or null for none

setTitle

public Document setTitle(String title)

The title of the document.

Parameters:

title - title or null for none

set

public Document set(String fieldName,
                    Object value)

Overrides:

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

clone

public Document clone()

Overrides:

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