Send feedback
Class Page (2.50.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.50.1 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int
SUBPAGES_FIELD_NUMBER
public static final int SUBPAGES_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Page getDefaultInstance ()
Returns
Type Description
Page
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Page . Builder newBuilder ()
newBuilder(Page prototype)
public static Page . Builder newBuilder ( Page prototype )
Parameter
Name Description
prototypePage
parseDelimitedFrom(InputStream input)
public static Page parseDelimitedFrom ( InputStream input )
Returns
Type Description
Page
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parseFrom(byte[] data)
public static Page parseFrom ( byte [] data )
Parameter
Name Description
databyte []
Returns
Type Description
Page
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parseFrom(ByteString data)
public static Page parseFrom ( ByteString data )
Returns
Type Description
Page
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parseFrom(CodedInputStream input)
public static Page parseFrom ( CodedInputStream input )
Returns
Type Description
Page
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parseFrom(InputStream input)
public static Page parseFrom ( InputStream input )
Returns
Type Description
Page
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parseFrom(ByteBuffer data)
public static Page parseFrom ( ByteBuffer data )
Returns
Type Description
Page
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Page parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Returns
Type Description
Page
parser()
public static Parser<Page> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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
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.
getParserForType()
public Parser<Page> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
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
Name Description
indexint
Returns
Type Description
Page
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
indexint
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 >
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Page . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Page . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Page . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-02-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-02-04 UTC."],[],[]]
