Class Page.Builder

public static final class Page.Builder extends 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

Implements

PageOrBuilder

Methods

addAllSubpages(Iterable<? extends Page> values)

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;

Parameter
NameDescription
valuesIterable<? extends com.google.api.Page>
Returns
TypeDescription
Page.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Page.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Page.Builder
Overrides

addSubpages(Page value)

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;

Parameter
NameDescription
valuePage
Returns
TypeDescription
Page.Builder

addSubpages(Page.Builder builderForValue)

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;

Parameter
NameDescription
builderForValuePage.Builder
Returns
TypeDescription
Page.Builder

addSubpages(int index, Page value)

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;

Parameters
NameDescription
indexint
valuePage
Returns
TypeDescription
Page.Builder

addSubpages(int index, Page.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValuePage.Builder
Returns
TypeDescription
Page.Builder

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;

Returns
TypeDescription
Page.Builder

addSubpagesBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Page.Builder

build()

public Page build()
Returns
TypeDescription
Page

buildPartial()

public Page buildPartial()
Returns
TypeDescription
Page

clear()

public Page.Builder clear()
Returns
TypeDescription
Page.Builder
Overrides

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
TypeDescription
Page.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Page.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Page.Builder
Overrides

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.

string name = 1;

Returns
TypeDescription
Page.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Page.Builder
Overrides

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;

Returns
TypeDescription
Page.Builder

clone()

public Page.Builder clone()
Returns
TypeDescription
Page.Builder
Overrides

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;

Returns
TypeDescription
String

The content.

getContentBytes()

public 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
TypeDescription
ByteString

The bytes for content.

getDefaultInstanceForType()

public Page getDefaultInstanceForType()
Returns
TypeDescription
Page

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getSubpages(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Page

getSubpagesBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Page.Builder

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;

Returns
TypeDescription
List<Builder>

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<Page>

getSubpagesOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
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;

Returns
TypeDescription
List<? extends com.google.api.PageOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Page other)

public Page.Builder mergeFrom(Page other)
Parameter
NameDescription
otherPage
Returns
TypeDescription
Page.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Page.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Page.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Page.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Page.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Page.Builder
Overrides

removeSubpages(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
Page.Builder

setContent(String value)

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;

Parameter
NameDescription
valueString

The content to set.

Returns
TypeDescription
Page.Builder

This builder for chaining.

setContentBytes(ByteString value)

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

Parameter
NameDescription
valueByteString

The bytes for content to set.

Returns
TypeDescription
Page.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Page.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Page.Builder
Overrides

setName(String value)

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.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Page.Builder

This builder for chaining.

setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Page.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Page.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Page.Builder
Overrides

setSubpages(int index, Page value)

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;

Parameters
NameDescription
indexint
valuePage
Returns
TypeDescription
Page.Builder

setSubpages(int index, Page.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValuePage.Builder
Returns
TypeDescription
Page.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Page.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Page.Builder
Overrides