Page (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.api.Page

All Implemented Interfaces:: PageOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

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

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
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

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

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getContent()` The Markdown content of the page.
`ByteString`	`getContentBytes()` The Markdown content of the page.
`static Page`	`getDefaultInstance()`
`Page`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getName()` The name of the page.
`ByteString`	`getNameBytes()` The name of the page.
`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.
`UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Page.Builder`	`newBuilder()`
`static Page.Builder`	`newBuilder(Page prototype)`
`Page.Builder`	`newBuilderForType()`
`protected Page.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static Page`	`parseDelimitedFrom(java.io.InputStream input)`
`static Page`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(byte[] data)`
`static Page`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(java.nio.ByteBuffer data)`
`static Page`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(ByteString data)`
`static Page`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(CodedInputStream input)`
`static Page`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Page`	`parseFrom(java.io.InputStream input)`
`static Page`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Page>`	`parser()`
`Page.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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 UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class 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 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 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