Class Page (2.39.0)

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

Implements

PageOrBuilder

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()
Returns
Type Description
Descriptor

newBuilder()

public static Page.Builder newBuilder()
Returns
Type Description
Page.Builder

newBuilder(Page prototype)

public static Page.Builder newBuilder(Page prototype)
Parameter
Name Description
prototype Page
Returns
Type Description
Page.Builder

parseDelimitedFrom(InputStream input)

public static Page parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Page parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Page parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Page parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Page parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Page parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Page parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Page
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Page> parser()
Returns
Type Description
Parser<Page>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContent()

public String getContent()

The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</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>&#40;== include {path} ==&#41;</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()

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: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </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: &#40;== include tutorial.md ==&#41; subpages:
    • name: Java content: &#40;== include tutorial_java.md ==&#41; </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()
Returns
Type Description
Parser<Page>
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
index int
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;

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>

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Page.Builder newBuilderForType()
Returns
Type Description
Page.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Page.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Page.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Page.Builder toBuilder()
Returns
Type Description
Page.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException