public interface DocumentationOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDocumentationRootUrl()
public abstract String getDocumentationRootUrl()The URL to the root of documentation.
string documentation_root_url = 4;
| Type | Description |
String | The documentationRootUrl. |
getDocumentationRootUrlBytes()
public abstract ByteString getDocumentationRootUrlBytes()The URL to the root of documentation.
string documentation_root_url = 4;
| Type | Description |
ByteString | The bytes for documentationRootUrl. |
getOverview()
public abstract 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
overviewfield andpagesfield.
string overview = 2;
| Type | Description |
String | The overview. |
getOverviewBytes()
public abstract 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
overviewfield andpagesfield.
string overview = 2;
| Type | Description |
ByteString | The bytes for overview. |
getPages(int index)
public abstract Page getPages(int index)The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
| Name | Description |
index | int |
| Type | Description |
Page |
getPagesCount()
public abstract int getPagesCount()The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
| Type | Description |
int |
getPagesList()
public abstract List<Page> getPagesList()The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
| Type | Description |
List<Page> |
getPagesOrBuilder(int index)
public abstract PageOrBuilder getPagesOrBuilder(int index)The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
| Name | Description |
index | int |
| Type | Description |
PageOrBuilder |
getPagesOrBuilderList()
public abstract List<? extends PageOrBuilder> getPagesOrBuilderList()The top level pages for the documentation set.
repeated .google.api.Page pages = 5;
| Type | Description |
List<? extends com.google.api.PageOrBuilder> |
getRules(int index)
public abstract 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;
| Name | Description |
index | int |
| Type | Description |
DocumentationRule |
getRulesCount()
public abstract 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;
| Type | Description |
int |
getRulesList()
public abstract 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;
| Type | Description |
List<DocumentationRule> |
getRulesOrBuilder(int index)
public abstract 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;
| Name | Description |
index | int |
| Type | Description |
DocumentationRuleOrBuilder |
getRulesOrBuilderList()
public abstract 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;
| Type | Description |
List<? extends com.google.api.DocumentationRuleOrBuilder> |
getServiceRootUrl()
public abstract 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.
string service_root_url = 6;
| Type | Description |
String | The serviceRootUrl. |
getServiceRootUrlBytes()
public abstract ByteString getServiceRootUrlBytes()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.
string service_root_url = 6;
| Type | Description |
ByteString | The bytes for serviceRootUrl. |
getSummary()
public abstract 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.
string summary = 1;
| Type | Description |
String | The summary. |
getSummaryBytes()
public abstract ByteString getSummaryBytes() 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.
string summary = 1;
| Type | Description |
ByteString | The bytes for summary. |