Interface DocumentationOrBuilder

Version 2.8.2

• 2.49.0 (latest)
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface DocumentationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocumentationRootUrl()

public abstract String getDocumentationRootUrl()

The URL to the root of documentation.

string documentation_root_url = 4;

Returns

Type	Description
String	The documentationRootUrl.

getDocumentationRootUrlBytes()

public abstract ByteString getDocumentationRootUrlBytes()

The URL to the root of documentation.

string documentation_root_url = 4;

Returns

Type	Description
ByteString	The bytes for documentationRootUrl.

getOverview()

public abstract String getOverview()

Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;

include overview.md

&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages:

• name: Overview content: &#40;

  include overview.md

  &#41; </code></pre> Note: you cannot specify both overview field and pages field.

string overview = 2;

Returns

Type	Description
String	The overview.

getOverviewBytes()

public abstract ByteString getOverviewBytes()

Declares a single overview page. For example: <pre><code>documentation: summary: ... overview: &#40;

include overview.md

&#41; </code></pre> This is a shortcut for the following declaration (using pages style): <pre><code>documentation: summary: ... pages:

• name: Overview content: &#40;

  include overview.md

  &#41; </code></pre> Note: you cannot specify both overview field and pages field.

string overview = 2;

Returns

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;

Parameter

Name	Description
index	int

Returns

Type	Description
Page

getPagesCount()

public abstract int getPagesCount()

The top level pages for the documentation set.

repeated .google.api.Page pages = 5;

Returns

Type	Description
int

getPagesList()

public abstract List<Page> getPagesList()

The top level pages for the documentation set.

repeated .google.api.Page pages = 5;

Returns

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;

Parameter

Name	Description
index	int

Returns

Type	Description
PageOrBuilder

getPagesOrBuilderList()

public abstract List<? extends PageOrBuilder> getPagesOrBuilderList()

The top level pages for the documentation set.

repeated .google.api.Page pages = 5;

Returns

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;

Parameter

Name	Description
index	int

Returns

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;

Returns

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;

Returns

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;

Parameter

Name	Description
index	int

Returns

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;

Returns

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;

Returns

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;

Returns

Type	Description
ByteString	The bytes for serviceRootUrl.

getSummary()

public abstract String getSummary()

A short summary of what the service does. Can only be provided by plain text.

string summary = 1;

Returns

Type	Description
String	The summary.

getSummaryBytes()

public abstract ByteString getSummaryBytes()

A short summary of what the service does. Can only be provided by plain text.

string summary = 1;

Returns

Type	Description
ByteString	The bytes for summary.