com.google.api

Class Page

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.Page

All Implemented Interfaces:

PageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Page.Builder Represents a documentation page.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SUBPAGES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

SUBPAGES_FIELD_NUMBER

public static final int SUBPAGES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

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: &#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][Tutorial.Java]`.
 

string name = 1;

Specified by:

getName in interface PageOrBuilder

getNameBytes

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: &#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][Tutorial.Java]`.
 

string name = 1;

Specified by:

getNameBytes in interface PageOrBuilder

getContent

public java.lang.String getContent()

 The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
 to include content from a Markdown file.
 

string content = 2;

Specified by:

getContent in interface PageOrBuilder

getContentBytes

public com.google.protobuf.ByteString getContentBytes()

 The Markdown content of the page. You can use <code>&#40;== include {path} ==&#41;</code>
 to include content from a Markdown file.
 

string content = 2;

Specified by:

getContentBytes in interface PageOrBuilder

getSubpagesList

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;

Specified by:

getSubpagesList in interface PageOrBuilder

getSubpagesOrBuilderList

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;

Specified by:

getSubpagesOrBuilderList in interface PageOrBuilder

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;

Specified by:

getSubpagesCount in interface PageOrBuilder

getSubpages

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;

Specified by:

getSubpages in interface PageOrBuilder

getSubpagesOrBuilder

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;

Specified by:

getSubpagesOrBuilder in interface PageOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Page parseFrom(java.nio.ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(java.nio.ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Page parseFrom(java.io.InputStream input)
                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Page parseFrom(java.io.InputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Page parseDelimitedFrom(java.io.InputStream input)
                               throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Page parseDelimitedFrom(java.io.InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Page parseFrom(com.google.protobuf.CodedInputStream input)
                      throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Page parseFrom(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Page.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Page.Builder newBuilder()

newBuilder

public static Page.Builder newBuilder(Page prototype)

toBuilder

public Page.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Page.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Page getDefaultInstance()

parser

public static com.google.protobuf.Parser<Page> parser()

getParserForType

public com.google.protobuf.Parser<Page> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Page getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder