Interface PageOrBuilder (2.9.0)

Version 2.9.0

• 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 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.

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.

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>