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 Usage 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
Constructor and Description |
---|
Documentation() |
Modifier and Type | Method and Description |
---|---|
Documentation |
clone() |
java.lang.String |
getDocumentationRootUrl()
The URL to the root of documentation.
|
java.lang.String |
getOverview()
Declares a single overview page.
|
java.util.List<Page> |
getPages()
The top level pages for the documentation set.
|
java.util.List<DocumentationRule> |
getRules()
A list of documentation rules that apply to individual API elements.
|
java.lang.String |
getServiceRootUrl()
Specifies the service root url if the default one (the service name from the yaml file) is not
suitable.
|
java.lang.String |
getSummary()
A short summary of what the service does.
|
Documentation |
set(java.lang.String fieldName,
java.lang.Object value) |
Documentation |
setDocumentationRootUrl(java.lang.String documentationRootUrl)
The URL to the root of documentation.
|
Documentation |
setOverview(java.lang.String overview)
Declares a single overview page.
|
Documentation |
setPages(java.util.List<Page> pages)
The top level pages for the documentation set.
|
Documentation |
setRules(java.util.List<DocumentationRule> rules)
A list of documentation rules that apply to individual API elements.
|
Documentation |
setServiceRootUrl(java.lang.String serviceRootUrl)
Specifies the service root url if the default one (the service name from the yaml file) is not
suitable.
|
Documentation |
setSummary(java.lang.String summary)
A short summary of what the service does.
|
getFactory, setFactory, toPrettyString, toString
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values
public java.lang.String getDocumentationRootUrl()
null
for nonepublic Documentation setDocumentationRootUrl(java.lang.String documentationRootUrl)
documentationRootUrl
- documentationRootUrl or null
for nonepublic java.lang.String getOverview()
null
for nonepublic Documentation setOverview(java.lang.String overview)
overview
- overview or null
for nonepublic java.util.List<Page> getPages()
null
for nonepublic Documentation setPages(java.util.List<Page> pages)
pages
- pages or null
for nonepublic java.util.List<DocumentationRule> getRules()
null
for nonepublic Documentation setRules(java.util.List<DocumentationRule> rules)
rules
- rules or null
for nonepublic java.lang.String getServiceRootUrl()
null
for nonepublic Documentation setServiceRootUrl(java.lang.String serviceRootUrl)
serviceRootUrl
- serviceRootUrl or null
for nonepublic java.lang.String getSummary()
null
for nonepublic Documentation setSummary(java.lang.String summary)
summary
- summary or null
for nonepublic Documentation set(java.lang.String fieldName, java.lang.Object value)
set
in class com.google.api.client.json.GenericJson
public Documentation clone()
clone
in class com.google.api.client.json.GenericJson