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

Class InsertSectionBreakRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Inserts a section break at the given location. A newline character will be inserted before the section break.

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

Method Summary

Modifier and Type	Method and Description
InsertSectionBreakRequest	clone()
EndOfSegmentLocation	getEndOfSegmentLocation() Inserts a newline and a section break at the end of the document body.
Location	getLocation() Inserts a newline and a section break at a specific index in the document.
String	getSectionType() The type of section to insert.
InsertSectionBreakRequest	set(String fieldName, Object value)
InsertSectionBreakRequest	setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation) Inserts a newline and a section break at the end of the document body.
InsertSectionBreakRequest	setLocation(Location location) Inserts a newline and a section break at a specific index in the document.
InsertSectionBreakRequest	setSectionType(String sectionType) The type of section to insert.

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

InsertSectionBreakRequest

public InsertSectionBreakRequest()

Method Detail

getEndOfSegmentLocation

public EndOfSegmentLocation getEndOfSegmentLocation()

Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty.

Returns:

value or null for none

setEndOfSegmentLocation

public InsertSectionBreakRequest setEndOfSegmentLocation(EndOfSegmentLocation endOfSegmentLocation)

Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty.

Parameters:

endOfSegmentLocation - endOfSegmentLocation or null for none

getLocation

public Location getLocation()

Inserts a newline and a section break at a specific index in the document. The section break 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). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty.

Returns:

value or null for none

setLocation

public InsertSectionBreakRequest setLocation(Location location)

Inserts a newline and a section break at a specific index in the document. The section break 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). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty.

Parameters:

location - location or null for none

getSectionType

public String getSectionType()

The type of section to insert.

Returns:

value or null for none

setSectionType

public InsertSectionBreakRequest setSectionType(String sectionType)

The type of section to insert.

Parameters:

sectionType - sectionType or null for none

set

public InsertSectionBreakRequest set(String fieldName,
                                     Object value)

Overrides:

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

clone

public InsertSectionBreakRequest clone()

Overrides:

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