public final class Page extends com.google.protobuf.GeneratedMessageV3 implements PageOrBuilder
Represents a documentation page. A page can contain subpages to represent nested documentation set structure.Protobuf type
google.api.Page
Modifier and Type | Class and Description |
---|---|
static class |
Page.Builder
Represents a documentation page.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
CONTENT_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
SUBPAGES_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getContent()
The Markdown content of the page.
|
com.google.protobuf.ByteString |
getContentBytes()
The Markdown content of the page.
|
static Page |
getDefaultInstance() |
Page |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.lang.String |
getName()
The name of the page.
|
com.google.protobuf.ByteString |
getNameBytes()
The name of the page.
|
com.google.protobuf.Parser<Page> |
getParserForType() |
int |
getSerializedSize() |
Page |
getSubpages(int index)
Subpages of this page.
|
int |
getSubpagesCount()
Subpages of this page.
|
java.util.List<Page> |
getSubpagesList()
Subpages of this page.
|
PageOrBuilder |
getSubpagesOrBuilder(int index)
Subpages of this page.
|
java.util.List<? extends PageOrBuilder> |
getSubpagesOrBuilderList()
Subpages of this page.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Page.Builder |
newBuilder() |
static Page.Builder |
newBuilder(Page prototype) |
Page.Builder |
newBuilderForType() |
protected Page.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static Page |
parseDelimitedFrom(java.io.InputStream input) |
static Page |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Page |
parseFrom(byte[] data) |
static Page |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Page |
parseFrom(java.nio.ByteBuffer data) |
static Page |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Page |
parseFrom(com.google.protobuf.ByteString data) |
static Page |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Page |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Page |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Page |
parseFrom(java.io.InputStream input) |
static Page |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Page> |
parser() |
Page.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int NAME_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
public static final int SUBPAGES_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public java.lang.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 `Java` page using Markdown reference link syntax: `[Java][Tutorial.Java]`.
string name = 1;
getName
in interface PageOrBuilder
public com.google.protobuf.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][Tutorial.Java]`.
string name = 1;
getNameBytes
in interface PageOrBuilder
public java.lang.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;
getContent
in interface PageOrBuilder
public com.google.protobuf.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;
getContentBytes
in interface PageOrBuilder
public java.util.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;
getSubpagesList
in interface PageOrBuilder
public java.util.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;
getSubpagesOrBuilderList
in interface PageOrBuilder
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;
getSubpagesCount
in interface PageOrBuilder
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;
getSubpages
in interface PageOrBuilder
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;
getSubpagesOrBuilder
in interface PageOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static Page parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static Page parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Page parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Page parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static Page parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static Page parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static Page parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public Page.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static Page.Builder newBuilder()
public static Page.Builder newBuilder(Page prototype)
public Page.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected Page.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static Page getDefaultInstance()
public static com.google.protobuf.Parser<Page> parser()
public com.google.protobuf.Parser<Page> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public Page getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder