Send feedback
Class Page (2.10.0) Stay organized with collections
Save and categorize content based on your preferences.
Version 2.10.0 keyboard_arrow_down
public
final
class
Page
extends
GeneratedMessageV3
implements
PageOrBuilder
Represents a documentation page. A page can contain subpages to represent
nested documentation set structure.
Protobuf type google.api.Page
Static Fields
CONTENT_FIELD_NUMBER
public
static
final
int
CONTENT_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
Field Value
SUBPAGES_FIELD_NUMBER
public
static
final
int
SUBPAGES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public
static
Page
getDefaultInstance
()
Returns
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
Returns
newBuilder()
public
static
Page
.
Builder
newBuilder
()
Returns
newBuilder(Page prototype)
public
static
Page
.
Builder
newBuilder
(
Page
prototype
)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public
static
Page
parseDelimitedFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public
static
Page
parseFrom
(
byte
[]
data
)
Parameter
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public
static
Page
parseFrom
(
ByteString
data
)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public
static
Page
parseFrom
(
CodedInputStream
input
)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public
static
Page
parseFrom
(
InputStream
input
)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public
static
Page
parseFrom
(
ByteBuffer
data
)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
Parameters
Returns
Exceptions
parser()
public
static
Parser<Page>
parser
()
Returns
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
Parameter
Returns
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. string content = 2;
Returns
getContentBytes()
public
ByteString
getContentBytes
()
The Markdown content of the page. You can use <code>(
include {path}
)</code> to include content from a Markdown file. string content = 2;
Returns
getDefaultInstanceForType()
public
Page
getDefaultInstanceForType
()
Returns
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
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
getParserForType()
public
Parser<Page>
getParserForType
()
Returns
Overrides
getSerializedSize()
public
int
getSerializedSize
()
Returns
Overrides
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
Returns
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
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
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
Returns
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
getUnknownFields()
public
final
UnknownFieldSet
getUnknownFields
()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
Returns
Overrides
isInitialized()
public
final
boolean
isInitialized
()
Returns
Overrides
newBuilderForType()
public
Page
.
Builder
newBuilderForType
()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Page
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
Parameter
Returns
Overrides
toBuilder()
public
Page
.
Builder
toBuilder
()
Returns
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,[]]
