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

Class Link

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A reference to another portion of a document or an external URL resource.

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

Method Summary

Modifier and Type	Method and Description
Link	clone()
BookmarkLink	getBookmark() A bookmark in this document.
String	getBookmarkId() The ID of a bookmark in this document.
HeadingLink	getHeading() A heading in this document.
String	getHeadingId() The ID of a heading in this document.
String	getTabId() The ID of a tab in this document.
String	getUrl() An external URL.
Link	set(String fieldName, Object value)
Link	setBookmark(BookmarkLink bookmark) A bookmark in this document.
Link	setBookmarkId(String bookmarkId) The ID of a bookmark in this document.
Link	setHeading(HeadingLink heading) A heading in this document.
Link	setHeadingId(String headingId) The ID of a heading in this document.
Link	setTabId(String tabId) The ID of a tab in this document.
Link	setUrl(String url) An external URL.

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

Link

public Link()

Method Detail

getBookmark

public BookmarkLink getBookmark()

A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.

Returns:

value or null for none

setBookmark

public Link setBookmark(BookmarkLink bookmark)

A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.

Parameters:

bookmark - bookmark or null for none

getBookmarkId

public String getBookmarkId()

The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.

Returns:

value or null for none

setBookmarkId

public Link setBookmarkId(String bookmarkId)

The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.

Parameters:

bookmarkId - bookmarkId or null for none

getHeading

public HeadingLink getHeading()

A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.

Returns:

value or null for none

setHeading

public Link setHeading(HeadingLink heading)

A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.

Parameters:

heading - heading or null for none

getHeadingId

public String getHeadingId()

The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.

Returns:

value or null for none

setHeadingId

public Link setHeadingId(String headingId)

The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.

Parameters:

headingId - headingId or null for none

getTabId

public String getTabId()

The ID of a tab in this document.

Returns:

value or null for none

setTabId

public Link setTabId(String tabId)

The ID of a tab in this document.

Parameters:

tabId - tabId or null for none

getUrl

public String getUrl()

An external URL.

Returns:

value or null for none

setUrl

public Link setUrl(String url)

An external URL.

Parameters:

url - url or null for none

set

public Link set(String fieldName,
                Object value)

Overrides:

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

clone

public Link clone()

Overrides:

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