com.google.api.services.serviceconsumermanagement.v1.model

Class Page

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.serviceconsumermanagement.v1.model.Page

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Page
extends GenericJson

Represents a documentation page. A page can contain subpages to represent nested documentation set structure.

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 Service Consumer Management 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

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

Method Summary

Modifier and Type	Method and Description
Page	clone()
String	getContent() The Markdown content of the page.
String	getName() The name of the page.
List<Page>	getSubpages() Subpages of this page.
Page	set(String fieldName, Object value)
Page	setContent(String content) The Markdown content of the page.
Page	setName(String name) The name of the page.
Page	setSubpages(List<Page> subpages) Subpages of this page.

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

Page

public Page()

Method Detail

getContent

public String getContent()

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Returns:

value or null for none

setContent

public Page setContent(String content)

The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

Parameters:

content - content or null for none

getName

public String getName()

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.

Returns:

value or null for none

setName

public Page setName(String name)

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.

Parameters:

name - name or null for none

getSubpages

public List<Page> getSubpages()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Returns:

value or null for none

setSubpages

public Page setSubpages(List<Page> subpages)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

Parameters:

subpages - subpages or null for none

set

public Page set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public Page clone()

Overrides:

clone in class GenericJson