public final class Documentation
extends com.google.api.client.json.GenericJson
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
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
Documentation() |
Modifier and Type | Method and Description |
---|---|
Documentation |
clone() |
String |
getDocumentationRootUrl()
The URL to the root of documentation.
|
String |
getOverview()
Declares a single overview page.
|
List<Page> |
getPages()
The top level pages for the documentation set.
|
List<DocumentationRule> |
getRules()
A list of documentation rules that apply to individual API elements.
|
List<Page> |
getSectionOverrides()
Specifies section and content to override boilerplate content provided by go/api-docgen.
|
String |
getServiceRootUrl()
Specifies the service root url if the default one (the service name from the yaml file) is not
suitable.
|
String |
getSummary()
A short description of what the service does.
|
Documentation |
set(String fieldName,
Object value) |
Documentation |
setDocumentationRootUrl(String documentationRootUrl)
The URL to the root of documentation.
|
Documentation |
setOverview(String overview)
Declares a single overview page.
|
Documentation |
setPages(List<Page> pages)
The top level pages for the documentation set.
|
Documentation |
setRules(List<DocumentationRule> rules)
A list of documentation rules that apply to individual API elements.
|
Documentation |
setSectionOverrides(List<Page> sectionOverrides)
Specifies section and content to override boilerplate content provided by go/api-docgen.
|
Documentation |
setServiceRootUrl(String serviceRootUrl)
Specifies the service root url if the default one (the service name from the yaml file) is not
suitable.
|
Documentation |
setSummary(String summary)
A short description of what the service does.
|
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public String getDocumentationRootUrl()
null
for nonepublic Documentation setDocumentationRootUrl(String documentationRootUrl)
documentationRootUrl
- documentationRootUrl or null
for nonepublic String getOverview()
null
for nonepublic Documentation setOverview(String overview)
overview
- overview or null
for nonepublic List<Page> getPages()
null
for nonepublic Documentation setPages(List<Page> pages)
pages
- pages or null
for nonepublic List<DocumentationRule> getRules()
null
for nonepublic Documentation setRules(List<DocumentationRule> rules)
rules
- rules or null
for nonepublic List<Page> getSectionOverrides()
null
for nonepublic Documentation setSectionOverrides(List<Page> sectionOverrides)
sectionOverrides
- sectionOverrides or null
for nonepublic String getServiceRootUrl()
null
for nonepublic Documentation setServiceRootUrl(String serviceRootUrl)
serviceRootUrl
- serviceRootUrl or null
for nonepublic String getSummary()
null
for nonepublic Documentation setSummary(String summary)
summary
- summary or null
for nonepublic Documentation set(String fieldName, Object value)
set
in class com.google.api.client.json.GenericJson
public Documentation clone()
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.