Class Page (2.8.4)
- 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
publicfinalclassPageextendsGeneratedMessageV3implementsPageOrBuilderRepresents a documentation page. A page can contain subpages to represent nested documentation set structure.
Protobuf typegoogle.api.Page
Inheritance
Object >AbstractMessageLite<MessageType,BuilderType> >AbstractMessage >GeneratedMessageV3 >PageImplements
PageOrBuilderInherited Members
Static Fields
CONTENT_FIELD_NUMBER
publicstaticfinalintCONTENT_FIELD_NUMBER| Type | Description |
| int |
NAME_FIELD_NUMBER
publicstaticfinalintNAME_FIELD_NUMBER| Type | Description |
| int |
SUBPAGES_FIELD_NUMBER
publicstaticfinalintSUBPAGES_FIELD_NUMBER| Type | Description |
| int |
Static Methods
getDefaultInstance()
publicstaticPagegetDefaultInstance()| Type | Description |
| Page |
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()| Type | Description |
| Descriptor |
newBuilder()
publicstaticPage.BuildernewBuilder()| Type | Description |
| Page.Builder |
newBuilder(Page prototype)
publicstaticPage.BuildernewBuilder(Pageprototype)| Name | Description |
| prototype | Page |
| Type | Description |
| Page.Builder |
parseDelimitedFrom(InputStream input)
publicstaticPageparseDelimitedFrom(InputStreaminput)| Name | Description |
| input | InputStream |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseFrom(byte[] data)
publicstaticPageparseFrom(byte[]data)| Name | Description |
| data | byte[] |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| data | byte[] |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data)
publicstaticPageparseFrom(ByteStringdata)| Name | Description |
| data | ByteString |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| data | ByteString |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
publicstaticPageparseFrom(CodedInputStreaminput)| Name | Description |
| input | CodedInputStream |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseFrom(InputStream input)
publicstaticPageparseFrom(InputStreaminput)| Name | Description |
| input | InputStream |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| input | InputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| IOException |
parseFrom(ByteBuffer data)
publicstaticPageparseFrom(ByteBufferdata)| Name | Description |
| data | ByteBuffer |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticPageparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)| Name | Description |
| data | ByteBuffer |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Page |
| Type | Description |
| InvalidProtocolBufferException |
parser()
publicstaticParser<Page>parser()| Type | Description |
| Parser<Page> |
Methods
equals(Object obj)
publicbooleanequals(Objectobj)| Name | Description |
| obj | Object |
| Type | Description |
| boolean |
getContent()
publicStringgetContent()The Markdown content of the page. You can use <code>(
include {path}
)</code> to include content from a Markdown file.string content = 2;
| Type | Description |
| String | The content. |
getContentBytes()
publicByteStringgetContentBytes()The Markdown content of the page. You can use <code>(
include {path}
)</code> to include content from a Markdown file.string content = 2;
| Type | Description |
| ByteString | The bytes for content. |
getDefaultInstanceForType()
publicPagegetDefaultInstanceForType()| Type | Description |
| Page |
getName()
publicStringgetName() 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: Tutorialcontent: (
include tutorial.md
)subpages:- name: Javacontent: (
include tutorial_java.md
)</code></pre>You can referenceJavapage using Markdown reference link syntax:Java.
- name: Javacontent: (
string name = 1;
| Type | Description |
| String | The name. |
getNameBytes()
publicByteStringgetNameBytes() 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: Tutorialcontent: (
include tutorial.md
)subpages:- name: Javacontent: (
include tutorial_java.md
)</code></pre>You can referenceJavapage using Markdown reference link syntax:Java.
- name: Javacontent: (
string name = 1;
| Type | Description |
| ByteString | The bytes for name. |
getParserForType()
publicParser<Page>getParserForType()| Type | Description |
| Parser<Page> |
getSerializedSize()
publicintgetSerializedSize()| Type | Description |
| int |
getSubpages(int index)
publicPagegetSubpages(intindex)Subpages of this page. The order of subpages specified here will be honored in the generated docset.
repeated .google.api.Page subpages = 3;
| Name | Description |
| index | int |
| Type | Description |
| Page |
getSubpagesCount()
publicintgetSubpagesCount()Subpages of this page. The order of subpages specified here will be honored in the generated docset.
repeated .google.api.Page subpages = 3;
| Type | Description |
| int |
getSubpagesList()
publicList<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;
| Type | Description |
| List<Page> |
getSubpagesOrBuilder(int index)
publicPageOrBuildergetSubpagesOrBuilder(intindex)Subpages of this page. The order of subpages specified here will be honored in the generated docset.
repeated .google.api.Page subpages = 3;
| Name | Description |
| index | int |
| Type | Description |
| PageOrBuilder |
getSubpagesOrBuilderList()
publicList<?extendsPageOrBuilder>getSubpagesOrBuilderList()Subpages of this page. The order of subpages specified here will be honored in the generated docset.
repeated .google.api.Page subpages = 3;
| Type | Description |
| List<? extends com.google.api.PageOrBuilder> |
getUnknownFields()
publicfinalUnknownFieldSetgetUnknownFields()| Type | Description |
| UnknownFieldSet |
hashCode()
publicinthashCode()| Type | Description |
| int |
internalGetFieldAccessorTable()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
publicfinalbooleanisInitialized()| Type | Description |
| boolean |
newBuilderForType()
publicPage.BuildernewBuilderForType()| Type | Description |
| Page.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedPage.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)| Name | Description |
| parent | BuilderParent |
| Type | Description |
| Page.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)| Name | Description |
| unused | UnusedPrivateParameter |
| Type | Description |
| Object |
toBuilder()
publicPage.BuildertoBuilder()| Type | Description |
| Page.Builder |
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)| Name | Description |
| output | CodedOutputStream |
| Type | Description |
| IOException |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-31 UTC.