Package com.google.api

Class Page.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>
com.google.api.Page.Builder
All Implemented Interfaces:
PageOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Page
public static final class Page.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder> implements PageOrBuilder
 Represents a documentation page. A page can contain subpages to represent
 nested documentation set structure.
Protobuf type google.api.Page

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • clear

      public Page.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • getDefaultInstanceForType

      public Page getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Page build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Page buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Page.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • setField

      public Page.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • clearField

      public Page.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • clearOneof

      public Page.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • setRepeatedField

      public Page.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • addRepeatedField

      public Page.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • mergeFrom

      public Page.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Page.Builder>

    • mergeFrom

      public Page.Builder mergeFrom(Page other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • mergeFrom

      public Page.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Page.Builder>
      Throws:
      IOException

    • getName

      public 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;
      Specified by:
      getName in interface PageOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface PageOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Page.Builder setName(String value)
       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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Page.Builder clearName()
       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:
      This builder for chaining.

    • setNameBytes

      public Page.Builder setNameBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getContent

      public 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;
      Specified by:
      getContent in interface PageOrBuilder
      Returns:
      The content.

    • getContentBytes

      public 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;
      Specified by:
      getContentBytes in interface PageOrBuilder
      Returns:
      The bytes for content.

    • setContent

      public Page.Builder setContent(String value)
       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;
      Parameters:
      value - The content to set.
      Returns:
      This builder for chaining.

    • clearContent

      public Page.Builder clearContent()
       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:
      This builder for chaining.

    • setContentBytes

      public Page.Builder setContentBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for content to set.
      Returns:
      This builder for chaining.

    • getSubpagesList

      public 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;
      Specified by:
      getSubpagesList in interface PageOrBuilder

    • getSubpagesCount

      public 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;
      Specified by:
      getSubpagesCount in interface PageOrBuilder

    • getSubpages

      public 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;
      Specified by:
      getSubpages in interface PageOrBuilder

    • setSubpages

      public Page.Builder setSubpages(int index, Page value)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • setSubpages

      public Page.Builder setSubpages(int index, Page.Builder builderForValue)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addSubpages

      public Page.Builder addSubpages(Page value)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addSubpages

      public Page.Builder addSubpages(int index, Page value)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addSubpages

      public Page.Builder addSubpages(Page.Builder builderForValue)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addSubpages

      public Page.Builder addSubpages(int index, Page.Builder builderForValue)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addAllSubpages

      public Page.Builder addAllSubpages(Iterable<? extends Page> values)
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • clearSubpages

      public Page.Builder clearSubpages()
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • removeSubpages

      public Page.Builder removeSubpages(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;

    • getSubpagesBuilder

      public Page.Builder getSubpagesBuilder(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;

    • getSubpagesOrBuilder

      public 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;
      Specified by:
      getSubpagesOrBuilder in interface PageOrBuilder

    • getSubpagesOrBuilderList

      public 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;
      Specified by:
      getSubpagesOrBuilderList in interface PageOrBuilder

    • addSubpagesBuilder

      public Page.Builder addSubpagesBuilder()
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • addSubpagesBuilder

      public Page.Builder addSubpagesBuilder(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;

    • getSubpagesBuilderList

      public List<Page.Builder> getSubpagesBuilderList()
       Subpages of this page. The order of subpages specified here will be
 honored in the generated docset.
      repeated .google.api.Page subpages = 3;

    • setUnknownFields

      public final Page.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>

    • mergeUnknownFields

      public final Page.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Page.Builder>