target.apidocs.com.google.api.services.servicemanagement.model.Page.html Maven / Gradle / Ivy
Page (Service Management API v1-rev20240823-2.0.0)
com.google.api.services.servicemanagement.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.servicemanagement.model.Page
-
public final class Page
extends com.google.api.client.json.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 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
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
Page()
-
Method Summary
All Methods Instance Methods Concrete Methods
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
-
-
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 com.google.api.client.json.GenericJson
-
clone
public Page clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy