- 2.61.0 (latest)
- 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
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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PageImplements
PageOrBuilderStatic Fields
CONTENT_FIELD_NUMBER
public
static
final
int
CONTENT_FIELD_NUMBER
NAME_FIELD_NUMBER
public
static
final
int
NAME_FIELD_NUMBER
SUBPAGES_FIELD_NUMBER
public
static
final
int
SUBPAGES_FIELD_NUMBER
Static Methods
getDefaultInstance()
public
static
Page
getDefaultInstance
()
getDescriptor()
public
static
final
Descriptors
.
Descriptor
getDescriptor
()
newBuilder()
public
static
Page
.
Builder
newBuilder
()
newBuilder(Page prototype)
public
static
Page
.
Builder
newBuilder
(
Page
prototype
)
parseDelimitedFrom(InputStream input)
public
static
Page
parseDelimitedFrom
(
InputStream
input
)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseDelimitedFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(byte[] data)
public
static
Page
parseFrom
(
byte
[]
data
)
data
byte
[]
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
byte
[]
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteString data)
public
static
Page
parseFrom
(
ByteString
data
)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
ByteString
data
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(CodedInputStream input)
public
static
Page
parseFrom
(
CodedInputStream
input
)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
CodedInputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(InputStream input)
public
static
Page
parseFrom
(
InputStream
input
)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
InputStream
input
,
ExtensionRegistryLite
extensionRegistry
)
parseFrom(ByteBuffer data)
public
static
Page
parseFrom
(
ByteBuffer
data
)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public
static
Page
parseFrom
(
ByteBuffer
data
,
ExtensionRegistryLite
extensionRegistry
)
parser()
public
static
Parser<Page>
parser
()
Methods
equals(Object obj)
public
boolean
equals
(
Object
obj
)
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;
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;
getDefaultInstanceForType()
public
Page
getDefaultInstanceForType
()
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.
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
string name = 1;
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.
- name: Java
content: (== include tutorial_java.md ==)
</code></pre>
You can reference
string name = 1;
getParserForType()
public
Parser<Page>
getParserForType
()
getSerializedSize()
public
int
getSerializedSize
()
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;
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;
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;
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;
hashCode()
public
int
hashCode
()
internalGetFieldAccessorTable()
protected
GeneratedMessageV3
.
FieldAccessorTable
internalGetFieldAccessorTable
()
isInitialized()
public
final
boolean
isInitialized
()
newBuilderForType()
public
Page
.
Builder
newBuilderForType
()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected
Page
.
Builder
newBuilderForType
(
GeneratedMessageV3
.
BuilderParent
parent
)
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected
Object
newInstance
(
GeneratedMessageV3
.
UnusedPrivateParameter
unused
)
toBuilder()
public
Page
.
Builder
toBuilder
()
writeTo(CodedOutputStream output)
public
void
writeTo
(
CodedOutputStream
output
)
