Package com.google.api

Interface PageOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Page, Page.Builder
public interface PageOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getContent()
    The Markdown content of the page.
    com.google.protobuf.ByteString
    getContentBytes()
    The Markdown content of the page.
    String
    getName()
    The name of the page.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the page.
    Page
    getSubpages(int index)
    Subpages of this page.
    int
    getSubpagesCount()
    Subpages of this page.
    List<Page>
    getSubpagesList()
    Subpages of this page.
    PageOrBuilder
    getSubpagesOrBuilder(int index)
    Subpages of this page.
    List<? extends PageOrBuilder>
    getSubpagesOrBuilderList()
    Subpages of this page.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      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][Tutorial.Java]`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.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][Tutorial.Java]`.
      string name = 1;
      Returns:
      The bytes for name.

    • getContent

      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:
      The content.

    • getContentBytes

      com.google.protobuf.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:
      The bytes for content.

    • getSubpagesList

      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;

    • getSubpages

      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;

    • getSubpagesCount

      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;

    • getSubpagesOrBuilderList

      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;

    • getSubpagesOrBuilder

      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;