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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
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 |
|---|
| Name | Description |
values | Iterable<? extends com.google.api.Page>
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Page.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
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 |
|---|
| Name | Description |
value | Page
|
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;
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 |
|---|
| Name | Description |
index | int
|
value | Page
|
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;
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(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 |
|---|
| Name | Description |
index | int
|
build()
| Returns |
|---|
| Type | Description |
Page | |
buildPartial()
public Page buildPartial()
| Returns |
|---|
| Type | Description |
Page | |
clear()
public Page.Builder clear()
Overrides
clearContent()
public Page.Builder clearContent()
The Markdown content of the page. You can use <code>(== include {path}
==)</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 |
Page.Builder | This builder for chaining.
|
clearField(Descriptors.FieldDescriptor field)
public Page.Builder clearField(Descriptors.FieldDescriptor field)
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: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Java page using Markdown reference link syntax:
Java.
string name = 1;
| Returns |
|---|
| Type | Description |
Page.Builder | This builder for chaining.
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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;
clone()
public Page.Builder clone()
Overrides
getContent()
public String getContent()
The Markdown content of the page. You can use <code>(== include {path}
==)</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 ByteString getContentBytes()
The Markdown content of the page. You can use <code>(== include {path}
==)</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.
|
getDefaultInstanceForType()
public Page getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Page | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Java page using Markdown reference link syntax:
Java.
string name = 1;
| Returns |
|---|
| Type | Description |
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: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</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 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 | |
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 |
|---|
| Name | Description |
index | int
|
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;
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 |
|---|
| Type | Description |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.api.PageOrBuilder> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(Page other)
public Page.Builder mergeFrom(Page other)
| Parameter |
|---|
| Name | Description |
other | Page
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Page.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Page.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
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 |
|---|
| Name | Description |
index | int
|
setContent(String value)
public Page.Builder setContent(String value)
The Markdown content of the page. You can use <code>(== include {path}
==)</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;
| Parameter |
|---|
| Name | Description |
value | String
The content to set.
|
| Returns |
|---|
| Type | Description |
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>(== include {path}
==)</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;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for content to set.
|
| Returns |
|---|
| Type | Description |
Page.Builder | This builder for chaining.
|
setField(Descriptors.FieldDescriptor field, Object value)
public Page.Builder setField(Descriptors.FieldDescriptor field, Object value)
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: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Java page using Markdown reference link syntax:
Java.
string name = 1;
| Parameter |
|---|
| Name | Description |
value | String
The name to set.
|
| Returns |
|---|
| Type | Description |
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: (== include tutorial.md ==)
subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Java page using Markdown reference link syntax:
Java.
string name = 1;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for name to set.
|
| Returns |
|---|
| Type | Description |
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)
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 |
|---|
| Name | Description |
index | int
|
value | Page
|
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;
setUnknownFields(UnknownFieldSet unknownFields)
public final Page.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
