public static final class Documentation.Builder extends GeneratedMessageV3.Builder<Documentation.Builder> implements DocumentationOrBuilder
`Documentation` provides the information for describing a service.
Example:
<pre><code>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: >
...
</code></pre>
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:
<pre><code>[fully.qualified.proto.name][]</code></pre>
To override the display text used for the link, this can be used:
<pre><code>[display text][fully.qualified.proto.name]</code></pre>
Text can be excluded from doc using the following notation:
<pre><code>(-- internal comment --)</code></pre>
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:
<pre><code>(== include path/to/file ==)</code></pre>
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:
<pre><code>(== resource_for v1.shelves.books ==)</code></pre>
The directive `suppress_warning` does not directly affect documentation
and is documented together with service config validation.
Protobuf type google.api.Documentation| Modifier and Type | Method and Description |
|---|---|
Documentation.Builder |
addAllPages(java.lang.Iterable<? extends Page> values)
The top level pages for the documentation set.
|
Documentation.Builder |
addAllRules(java.lang.Iterable<? extends DocumentationRule> values)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
addPages(int index,
Page.Builder builderForValue)
The top level pages for the documentation set.
|
Documentation.Builder |
addPages(int index,
Page value)
The top level pages for the documentation set.
|
Documentation.Builder |
addPages(Page.Builder builderForValue)
The top level pages for the documentation set.
|
Documentation.Builder |
addPages(Page value)
The top level pages for the documentation set.
|
Page.Builder |
addPagesBuilder()
The top level pages for the documentation set.
|
Page.Builder |
addPagesBuilder(int index)
The top level pages for the documentation set.
|
Documentation.Builder |
addRepeatedField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Documentation.Builder |
addRules(DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
addRules(DocumentationRule value)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
addRules(int index,
DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
addRules(int index,
DocumentationRule value)
A list of documentation rules that apply to individual API elements.
|
DocumentationRule.Builder |
addRulesBuilder()
A list of documentation rules that apply to individual API elements.
|
DocumentationRule.Builder |
addRulesBuilder(int index)
A list of documentation rules that apply to individual API elements.
|
Documentation |
build() |
Documentation |
buildPartial() |
Documentation.Builder |
clear() |
Documentation.Builder |
clearDocumentationRootUrl()
The URL to the root of documentation.
|
Documentation.Builder |
clearField(Descriptors.FieldDescriptor field) |
Documentation.Builder |
clearOneof(Descriptors.OneofDescriptor oneof) |
Documentation.Builder |
clearOverview()
Declares a single overview page.
|
Documentation.Builder |
clearPages()
The top level pages for the documentation set.
|
Documentation.Builder |
clearRules()
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
clearSummary()
A short summary of what the service does.
|
Documentation.Builder |
clone() |
Documentation |
getDefaultInstanceForType() |
static Descriptors.Descriptor |
getDescriptor() |
Descriptors.Descriptor |
getDescriptorForType() |
java.lang.String |
getDocumentationRootUrl()
The URL to the root of documentation.
|
ByteString |
getDocumentationRootUrlBytes()
The URL to the root of documentation.
|
java.lang.String |
getOverview()
Declares a single overview page.
|
ByteString |
getOverviewBytes()
Declares a single overview page.
|
Page |
getPages(int index)
The top level pages for the documentation set.
|
Page.Builder |
getPagesBuilder(int index)
The top level pages for the documentation set.
|
java.util.List<Page.Builder> |
getPagesBuilderList()
The top level pages for the documentation set.
|
int |
getPagesCount()
The top level pages for the documentation set.
|
java.util.List<Page> |
getPagesList()
The top level pages for the documentation set.
|
PageOrBuilder |
getPagesOrBuilder(int index)
The top level pages for the documentation set.
|
java.util.List<? extends PageOrBuilder> |
getPagesOrBuilderList()
The top level pages for the documentation set.
|
DocumentationRule |
getRules(int index)
A list of documentation rules that apply to individual API elements.
|
DocumentationRule.Builder |
getRulesBuilder(int index)
A list of documentation rules that apply to individual API elements.
|
java.util.List<DocumentationRule.Builder> |
getRulesBuilderList()
A list of documentation rules that apply to individual API elements.
|
int |
getRulesCount()
A list of documentation rules that apply to individual API elements.
|
java.util.List<DocumentationRule> |
getRulesList()
A list of documentation rules that apply to individual API elements.
|
DocumentationRuleOrBuilder |
getRulesOrBuilder(int index)
A list of documentation rules that apply to individual API elements.
|
java.util.List<? extends DocumentationRuleOrBuilder> |
getRulesOrBuilderList()
A list of documentation rules that apply to individual API elements.
|
java.lang.String |
getSummary()
A short summary of what the service does.
|
ByteString |
getSummaryBytes()
A short summary of what the service does.
|
protected GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Documentation.Builder |
mergeFrom(CodedInputStream input,
ExtensionRegistryLite extensionRegistry) |
Documentation.Builder |
mergeFrom(Documentation other) |
Documentation.Builder |
mergeFrom(Message other) |
Documentation.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields) |
Documentation.Builder |
removePages(int index)
The top level pages for the documentation set.
|
Documentation.Builder |
removeRules(int index)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
setDocumentationRootUrl(java.lang.String value)
The URL to the root of documentation.
|
Documentation.Builder |
setDocumentationRootUrlBytes(ByteString value)
The URL to the root of documentation.
|
Documentation.Builder |
setField(Descriptors.FieldDescriptor field,
java.lang.Object value) |
Documentation.Builder |
setOverview(java.lang.String value)
Declares a single overview page.
|
Documentation.Builder |
setOverviewBytes(ByteString value)
Declares a single overview page.
|
Documentation.Builder |
setPages(int index,
Page.Builder builderForValue)
The top level pages for the documentation set.
|
Documentation.Builder |
setPages(int index,
Page value)
The top level pages for the documentation set.
|
Documentation.Builder |
setRepeatedField(Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Documentation.Builder |
setRules(int index,
DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
setRules(int index,
DocumentationRule value)
A list of documentation rules that apply to individual API elements.
|
Documentation.Builder |
setSummary(java.lang.String value)
A short summary of what the service does.
|
Documentation.Builder |
setSummaryBytes(ByteString value)
A short summary of what the service does.
|
Documentation.Builder |
setUnknownFields(UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofmergeFrompublic static final Descriptors.Descriptor getDescriptor()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder clear()
clear in interface Message.Builderclear in interface MessageLite.Builderclear in class GeneratedMessageV3.Builder<Documentation.Builder>public Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface Message.BuildergetDescriptorForType in interface MessageOrBuildergetDescriptorForType in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderpublic Documentation build()
build in interface Message.Builderbuild in interface MessageLite.Builderpublic Documentation buildPartial()
buildPartial in interface Message.BuilderbuildPartial in interface MessageLite.Builderpublic Documentation.Builder clone()
clone in interface Message.Builderclone in interface MessageLite.Builderclone in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder setField(Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface Message.BuildersetField in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder clearField(Descriptors.FieldDescriptor field)
clearField in interface Message.BuilderclearField in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
clearOneof in interface Message.BuilderclearOneof in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface Message.BuildersetRepeatedField in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface Message.BuilderaddRepeatedField in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder mergeFrom(Message other)
mergeFrom in interface Message.BuildermergeFrom in class AbstractMessage.Builder<Documentation.Builder>public Documentation.Builder mergeFrom(Documentation other)
public final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3.Builder<Documentation.Builder>public Documentation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface Message.BuildermergeFrom in interface MessageLite.BuildermergeFrom in class AbstractMessage.Builder<Documentation.Builder>java.io.IOExceptionpublic java.lang.String getSummary()
A short summary of what the service does. Can only be provided by plain text.
string summary = 1;getSummary in interface DocumentationOrBuilderpublic ByteString getSummaryBytes()
A short summary of what the service does. Can only be provided by plain text.
string summary = 1;getSummaryBytes in interface DocumentationOrBuilderpublic Documentation.Builder setSummary(java.lang.String value)
A short summary of what the service does. Can only be provided by plain text.
string summary = 1;public Documentation.Builder clearSummary()
A short summary of what the service does. Can only be provided by plain text.
string summary = 1;public Documentation.Builder setSummaryBytes(ByteString value)
A short summary of what the service does. Can only be provided by plain text.
string summary = 1;public java.util.List<Page> getPagesList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;getPagesList in interface DocumentationOrBuilderpublic int getPagesCount()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;getPagesCount in interface DocumentationOrBuilderpublic Page getPages(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;getPages in interface DocumentationOrBuilderpublic Documentation.Builder setPages(int index, Page value)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder setPages(int index, Page.Builder builderForValue)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder addPages(Page value)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder addPages(int index, Page value)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder addPages(Page.Builder builderForValue)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder addPages(int index, Page.Builder builderForValue)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder addAllPages(java.lang.Iterable<? extends Page> values)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder clearPages()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Documentation.Builder removePages(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Page.Builder getPagesBuilder(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public PageOrBuilder getPagesOrBuilder(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;getPagesOrBuilder in interface DocumentationOrBuilderpublic java.util.List<? extends PageOrBuilder> getPagesOrBuilderList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;getPagesOrBuilderList in interface DocumentationOrBuilderpublic Page.Builder addPagesBuilder()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public Page.Builder addPagesBuilder(int index)
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public java.util.List<Page.Builder> getPagesBuilderList()
The top level pages for the documentation set.
repeated .google.api.Page pages = 5;public java.util.List<DocumentationRule> getRulesList()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;getRulesList in interface DocumentationOrBuilderpublic int getRulesCount()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;getRulesCount in interface DocumentationOrBuilderpublic DocumentationRule getRules(int index)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;getRules in interface DocumentationOrBuilderpublic Documentation.Builder setRules(int index, DocumentationRule value)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder setRules(int index, DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder addRules(DocumentationRule value)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder addRules(int index, DocumentationRule value)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder addRules(DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder addRules(int index, DocumentationRule.Builder builderForValue)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder addAllRules(java.lang.Iterable<? extends DocumentationRule> values)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder clearRules()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public Documentation.Builder removeRules(int index)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public DocumentationRule.Builder getRulesBuilder(int index)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public DocumentationRuleOrBuilder getRulesOrBuilder(int index)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;getRulesOrBuilder in interface DocumentationOrBuilderpublic java.util.List<? extends DocumentationRuleOrBuilder> getRulesOrBuilderList()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;getRulesOrBuilderList in interface DocumentationOrBuilderpublic DocumentationRule.Builder addRulesBuilder()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public DocumentationRule.Builder addRulesBuilder(int index)
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public java.util.List<DocumentationRule.Builder> getRulesBuilderList()
A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order.
repeated .google.api.DocumentationRule rules = 3;public java.lang.String getDocumentationRootUrl()
The URL to the root of documentation.
string documentation_root_url = 4;getDocumentationRootUrl in interface DocumentationOrBuilderpublic ByteString getDocumentationRootUrlBytes()
The URL to the root of documentation.
string documentation_root_url = 4;getDocumentationRootUrlBytes in interface DocumentationOrBuilderpublic Documentation.Builder setDocumentationRootUrl(java.lang.String value)
The URL to the root of documentation.
string documentation_root_url = 4;public Documentation.Builder clearDocumentationRootUrl()
The URL to the root of documentation.
string documentation_root_url = 4;public Documentation.Builder setDocumentationRootUrlBytes(ByteString value)
The URL to the root of documentation.
string documentation_root_url = 4;public java.lang.String getOverview()
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;getOverview in interface DocumentationOrBuilderpublic ByteString getOverviewBytes()
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;getOverviewBytes in interface DocumentationOrBuilderpublic Documentation.Builder setOverview(java.lang.String value)
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;public Documentation.Builder clearOverview()
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;public Documentation.Builder setOverviewBytes(ByteString value)
Declares a single overview page. For example:
<pre><code>documentation:
summary: ...
overview: (== include overview.md ==)
</code></pre>
This is a shortcut for the following declaration (using pages style):
<pre><code>documentation:
summary: ...
pages:
- name: Overview
content: (== include overview.md ==)
</code></pre>
Note: you cannot specify both `overview` field and `pages` field.
string overview = 2;public final Documentation.Builder setUnknownFields(UnknownFieldSet unknownFields)
setUnknownFields in interface Message.BuildersetUnknownFields in class GeneratedMessageV3.Builder<Documentation.Builder>public final Documentation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
mergeUnknownFields in interface Message.BuildermergeUnknownFields in class GeneratedMessageV3.Builder<Documentation.Builder>