- 2.65.0 (latest)
- 2.64.1
- 2.63.2
- 2.62.0
- 2.61.3
- 2.60.0
- 2.59.2
- 2.58.0
- 2.57.0
- 2.56.0
- 2.54.1
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.1
- 2.49.0
- 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 static final class Page.Builder extends GeneratedMessage.Builder<Page.Builder> implements PageOrBuilderRepresents a documentation page. A page can contain subpages to represent nested documentation set structure.
Protobuf type google.api.Page
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > Page.BuilderImplements
PageOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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> |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Page.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
value |
Page |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Page.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
build()
public Page build()| Returns | |
|---|---|
| Type | Description |
Page |
|
buildPartial()
public Page buildPartial()| Returns | |
|---|---|
| Type | Description |
Page |
|
clear()
public Page.Builder clear()| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
clearContent()
public Page.Builder clearContent() The Markdown content of the page. You can use <code><code>(== include {path}
==)</code></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. |
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
Javapage using Markdown reference link syntax:Java.
string name = 1;
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
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 | |
|---|---|
| Type | Description |
Page.Builder |
|
getContent()
public String getContent() The Markdown content of the page. You can use <code><code>(== include {path}
==)</code></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><code>(== include {path}
==)</code></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()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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: (== include tutorial.md ==) subpages:
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
Javapage 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
Javapage 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 |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
List<? extends com.google.api.PageOrBuilder> |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Page other)
public Page.Builder mergeFrom(Page other)| Parameter | |
|---|---|
| Name | Description |
other |
Page |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Page.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|
setContent(String value)
public Page.Builder setContent(String value) The Markdown content of the page. You can use <code><code>(== include {path}
==)</code></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 |
StringThe 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><code>(== include {path}
==)</code></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 |
ByteStringThe bytes for content to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
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
Javapage using Markdown reference link syntax:Java.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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
Javapage using Markdown reference link syntax:Java.
string name = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
This builder for chaining. |
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 |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Page.Builder |
| Returns | |
|---|---|
| Type | Description |
Page.Builder |
|