com.google.api.services.servicenetworking.v1beta.model

Class Documentation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.servicenetworking.v1beta.model.Documentation

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.

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 Networking 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
Documentation()

Method Summary

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.

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

Documentation

public Documentation()

Method Detail

getDocumentationRootUrl

public String getDocumentationRootUrl()

The URL to the root of documentation.

Returns:

value or null for none

setDocumentationRootUrl

public Documentation setDocumentationRootUrl(String documentationRootUrl)

The URL to the root of documentation.

Parameters:

documentationRootUrl - documentationRootUrl or null for none

getOverview

public String getOverview()

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.

Returns:

value or null for none

setOverview

public Documentation setOverview(String overview)

Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.

Parameters:

overview - overview or null for none

getPages

public List<Page> getPages()

The top level pages for the documentation set.

Returns:

value or null for none

setPages

public Documentation setPages(List<Page> pages)

The top level pages for the documentation set.

Parameters:

pages - pages or null for none

getRules

public List<DocumentationRule> getRules()

A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.

Returns:

value or null for none

setRules

public Documentation setRules(List<DocumentationRule> rules)

A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.

Parameters:

rules - rules or null for none

getSectionOverrides

public List<Page> getSectionOverrides()

Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries

Returns:

value or null for none

setSectionOverrides

public Documentation setSectionOverrides(List<Page> sectionOverrides)

Specifies section and content to override boilerplate content provided by go/api-docgen. Currently overrides following sections: 1. rest.service.client_libraries

Parameters:

sectionOverrides - sectionOverrides or null for none

getServiceRootUrl

public String getServiceRootUrl()

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Returns:

value or null for none

setServiceRootUrl

public Documentation setServiceRootUrl(String serviceRootUrl)

Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections that show a base that other urls are relative to.

Parameters:

serviceRootUrl - serviceRootUrl or null for none

getSummary

public String getSummary()

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.

Returns:

value or null for none

setSummary

public Documentation setSummary(String summary)

A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is equivalent to the standard field `description`.

Parameters:

summary - summary or null for none

set

public Documentation set(String fieldName,
                         Object value)

Overrides:

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

clone

public Documentation clone()

Overrides:

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