Interface PageOrBuilder (2.48.0)

public interface PageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContent()

public abstract String getContent()

The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

string content = 2;

Returns
Type Description
String

The content.

getContentBytes()

public abstract ByteString getContentBytes()

The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code> to include content from a Markdown file. The content can be used to produce the documentation page such as HTML format page.

string content = 2;

Returns
Type Description
ByteString

The bytes for content.

getName()

public abstract String getName()

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: <pre><code>pages:

  • name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference Java page using Markdown reference link syntax: Java.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the root page name to this page concatenated with .) can be used as reference to the page in your documentation. For example: <pre><code>pages:

  • name: Tutorial content: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </code></pre> You can reference Java page using Markdown reference link syntax: Java.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getSubpages(int index)

public abstract Page getSubpages(int index)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameter
Name Description
index int
Returns
Type Description
Page

getSubpagesCount()

public abstract int getSubpagesCount()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Returns
Type Description
int

getSubpagesList()

public abstract List<Page> getSubpagesList()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Returns
Type Description
List<Page>

getSubpagesOrBuilder(int index)

public abstract PageOrBuilder getSubpagesOrBuilder(int index)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameter
Name Description
index int
Returns
Type Description
PageOrBuilder

getSubpagesOrBuilderList()

public abstract List<? extends PageOrBuilder> getSubpagesOrBuilderList()

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Returns
Type Description
List<? extends com.google.api.PageOrBuilder>