Class Page.Builder (2.38.0)

public static final class Page.Builder extends GeneratedMessageV3.Builder<Page.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Page.Builder

Implements

PageOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllSubpages(Iterable<? extends Page> values)

public Page.Builder addAllSubpages(Iterable<? extends Page> values)

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
`values`	`Iterable<? extends com.google.api.Page>`

Returns
Type	Description
`Page.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Page.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSubpages(Page value)

public Page.Builder addSubpages(Page value)

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
`value`	`Page`

Returns
Type	Description
`Page.Builder`

addSubpages(Page.Builder builderForValue)

public Page.Builder addSubpages(Page.Builder builderForValue)

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
`builderForValue`	`Page.Builder`

Returns
Type	Description
`Page.Builder`

addSubpages(int index, Page value)

public Page.Builder addSubpages(int index, Page value)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Page`

Returns
Type	Description
`Page.Builder`

addSubpages(int index, Page.Builder builderForValue)

public Page.Builder addSubpages(int index, Page.Builder builderForValue)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Page.Builder`

Returns
Type	Description
`Page.Builder`

addSubpagesBuilder()

public Page.Builder addSubpagesBuilder()

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
`Page.Builder`

addSubpagesBuilder(int index)

public Page.Builder addSubpagesBuilder(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.Builder`

build()

public Page build()

Returns
Type	Description
`Page`

buildPartial()

public Page buildPartial()

Returns
Type	Description
`Page`

clear()

public Page.Builder clear()

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContent()

public Page.Builder clearContent()

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;

Returns
Type	Description
`Page.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Page.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public Page.Builder clearName()

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.

string name = 1;

Returns
Type	Description
`Page.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Page.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSubpages()

public Page.Builder clearSubpages()

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
`Page.Builder`

clone()

public Page.Builder clone()

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getContent()

public String getContent()

string content = 2;

Returns
Type	Description
`String`	The content.

getContentBytes()

public ByteString getContentBytes()

string content = 2;

Returns
Type	Description
`ByteString`	The bytes for content.

getDefaultInstanceForType()

public Page getDefaultInstanceForType()

Returns
Type	Description
`Page`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getName()

public String getName()

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.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

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.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

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`

getSubpagesBuilder(int index)

public Page.Builder getSubpagesBuilder(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.Builder`

getSubpagesBuilderList()

public List<Page.Builder> getSubpagesBuilderList()

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<Builder>`

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>`

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Page other)

public Page.Builder mergeFrom(Page other)

Parameter
Name	Description
`other`	`Page`

Returns
Type	Description
`Page.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Page.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Page.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Page.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Page.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Page.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeSubpages(int index)

public Page.Builder removeSubpages(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.Builder`

setContent(String value)

public Page.Builder setContent(String value)

string content = 2;

Parameter
Name	Description
`value`	`String` The content to set.

Returns
Type	Description
`Page.Builder`	This builder for chaining.

setContentBytes(ByteString value)

public Page.Builder setContentBytes(ByteString value)

string content = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for content to set.

Returns
Type	Description
`Page.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Page.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Page.Builder setName(String value)

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.

string name = 1;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Page.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Page.Builder setNameBytes(ByteString value)

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.

string name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Page.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Page.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSubpages(int index, Page value)

public Page.Builder setSubpages(int index, Page value)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Page`

Returns
Type	Description
`Page.Builder`

setSubpages(int index, Page.Builder builderForValue)

public Page.Builder setSubpages(int index, Page.Builder builderForValue)

Subpages of this page. The order of subpages specified here will be honored in the generated docset.

repeated .google.api.Page subpages = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Page.Builder`

Returns
Type	Description
`Page.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Page.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Page.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)