Class Document (0.3.0)

0.3.0 (latest) 0.2.0 0.1.0

public final class Document extends GeneratedMessage implements DocumentOrBuilder

A Document represents a piece of content from the Developer Knowledge corpus.

Protobuf type google.developers.knowledge.v1.Document

Inheritance

Object > com.google.protobuf.AbstractMessageLite > com.google.protobuf.AbstractMessage > com.google.protobuf.GeneratedMessage > Document

Implements

DocumentOrBuilder

Inherited Members

com.google.protobuf.AbstractMessage.equals(java.lang.Object)

com.google.protobuf.AbstractMessage.findInitializationErrors()

com.google.protobuf.AbstractMessage.getInitializationErrorString()

com.google.protobuf.AbstractMessage.hashCode()

com.google.protobuf.AbstractMessage.hashFields(int,java.util.Map<com.google.protobuf.Descriptors.FieldDescriptor,java.lang.Object>)

com.google.protobuf.AbstractMessage.newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent)

com.google.protobuf.AbstractMessage.toString()

com.google.protobuf.AbstractMessageLite.<T>addAll(java.lang.Iterable<T>,java.util.List<? super T>)

com.google.protobuf.AbstractMessageLite.checkByteStringIsUtf8(com.google.protobuf.ByteString)

com.google.protobuf.AbstractMessageLite.toByteArray()

com.google.protobuf.AbstractMessageLite.toByteString()

com.google.protobuf.AbstractMessageLite.writeDelimitedTo(java.io.OutputStream)

com.google.protobuf.AbstractMessageLite.writeTo(java.io.OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

com.google.protobuf.GeneratedMessage.<M>parseDelimitedWithIOException(com.google.protobuf.Parser<M>,java.io.InputStream)

com.google.protobuf.GeneratedMessage.<M>parseDelimitedWithIOException(com.google.protobuf.Parser<M>,java.io.InputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<M>parseWithIOException(com.google.protobuf.Parser<M>,com.google.protobuf.CodedInputStream)

com.google.protobuf.GeneratedMessage.<M>parseWithIOException(com.google.protobuf.Parser<M>,com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<M>parseWithIOException(com.google.protobuf.Parser<M>,java.io.InputStream)

com.google.protobuf.GeneratedMessage.<M>parseWithIOException(com.google.protobuf.Parser<M>,java.io.InputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

com.google.protobuf.GeneratedMessage.computeStringSize(int,java.lang.Object)

com.google.protobuf.GeneratedMessage.computeStringSizeNoTag(java.lang.Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

com.google.protobuf.GeneratedMessage.getAllFields()

com.google.protobuf.GeneratedMessage.getDescriptorForType()

com.google.protobuf.GeneratedMessage.getField(com.google.protobuf.Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.getOneofFieldDescriptor(com.google.protobuf.Descriptors.OneofDescriptor)

com.google.protobuf.GeneratedMessage.getParserForType()

com.google.protobuf.GeneratedMessage.getRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor,int)

com.google.protobuf.GeneratedMessage.getRepeatedFieldCount(com.google.protobuf.Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.getSerializedSize()

com.google.protobuf.GeneratedMessage.getUnknownFields()

com.google.protobuf.GeneratedMessage.hasField(com.google.protobuf.Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.hasOneof(com.google.protobuf.Descriptors.OneofDescriptor)

com.google.protobuf.GeneratedMessage.internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

com.google.protobuf.GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

com.google.protobuf.GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.writeReplace()

com.google.protobuf.GeneratedMessage.writeString(com.google.protobuf.CodedOutputStream,int,java.lang.Object)

com.google.protobuf.GeneratedMessage.writeStringNoTag(com.google.protobuf.CodedOutputStream,java.lang.Object)

com.google.protobuf.GeneratedMessage.writeTo(com.google.protobuf.CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

Field Value
Type	Description
int

CONTENT_LENGTH_BYTES_FIELD_NUMBER

public static final int CONTENT_LENGTH_BYTES_FIELD_NUMBER

Field Value
Type	Description
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_FIELD_NUMBER

Field Value
Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER

Field Value
Type	Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Document getDefaultInstance()

Returns
Type	Description
Document

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
com.google.protobuf.Descriptors.Descriptor

newBuilder()

public static Document.Builder newBuilder()

Returns
Type	Description
Document.Builder

newBuilder(Document prototype)

public static Document.Builder newBuilder(Document prototype)

Parameter
Name	Description
prototype	Document

Returns
Type	Description
Document.Builder

parseDelimitedFrom(InputStream input)

public static Document parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document parseFrom(ByteString data)

Parameter
Name	Description
data	com.google.protobuf.ByteString

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	com.google.protobuf.ByteString
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document parseFrom(CodedInputStream input)

Parameter
Name	Description
input	com.google.protobuf.CodedInputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	com.google.protobuf.CodedInputStream
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Document parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	com.google.protobuf.ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
com.google.protobuf.InvalidProtocolBufferException

parser()

public static Parser<Document> parser()

Returns
Type	Description
com.google.protobuf.Parser<Document>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

com.google.protobuf.AbstractMessage.equals(java.lang.Object)

getContent()

public String getContent()

Output only. Contains the full content of the document in Markdown format.

string content = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The content.

getContentBytes()

public ByteString getContentBytes()

Output only. Contains the full content of the document in Markdown format.

string content = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for content.

getContentLengthBytes()

public int getContentLengthBytes()

Output only. The length of the content field in bytes.

int32 content_length_bytes = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The contentLengthBytes.

getDataSource()

public String getDataSource()

Output only. Specifies the data source of the document. Example data source: firebase.google.com

string data_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

Output only. Specifies the data source of the document. Example data source: firebase.google.com

string data_source = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for dataSource.

getDefaultInstanceForType()

public Document getDefaultInstanceForType()

Returns
Type	Description
Document

getDescription()

public String getDescription()

Output only. Provides a description of the document.

string description = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Output only. Provides a description of the document.

string description = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for description.

getName()

public String getName()

Identifier. Contains the resource name of the document. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Contains the resource name of the document. Format: documents/{uri_without_scheme} Example: documents/docs.cloud.google.com/storage/docs/creating-buckets

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for name.

getParserForType()

public Parser<Document> getParserForType()

Returns
Type	Description
com.google.protobuf.Parser<Document>

Overrides

com.google.protobuf.GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

com.google.protobuf.GeneratedMessage.getSerializedSize()

getTitle()

public String getTitle()

Output only. Provides the title of the document.

string title = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The title.

getTitleBytes()

public ByteString getTitleBytes()

Output only. Provides the title of the document.

string title = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for title.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Represents the timestamp when the content or metadata of the document was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Represents the timestamp when the content or metadata of the document was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.TimestampOrBuilder

getUri()

public String getUri()

Output only. Provides the URI of the content, such as docs.cloud.google.com/storage/docs/creating-buckets.

string uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The uri.

getUriBytes()

public ByteString getUriBytes()

Output only. Provides the URI of the content, such as docs.cloud.google.com/storage/docs/creating-buckets.

string uri = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.protobuf.ByteString	The bytes for uri.

getView()

public DocumentView getView()

Output only. Specifies the DocumentView of the document.

.google.developers.knowledge.v1.DocumentView view = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
DocumentView	The view.

getViewValue()

public int getViewValue()

Output only. Specifies the DocumentView of the document.

.google.developers.knowledge.v1.DocumentView view = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for view.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Represents the timestamp when the content or metadata of the document was last updated.

.google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

com.google.protobuf.AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
com.google.protobuf.GeneratedMessage.FieldAccessorTable

Overrides

com.google.protobuf.GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

com.google.protobuf.GeneratedMessage.isInitialized()

newBuilderForType()

public Document.Builder newBuilderForType()

Returns
Type	Description
Document.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Document.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	com.google.protobuf.AbstractMessage.BuilderParent

Returns
Type	Description
Document.Builder

Overrides

com.google.protobuf.AbstractMessage.newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent)

toBuilder()

public Document.Builder toBuilder()

Returns
Type	Description
Document.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	com.google.protobuf.CodedOutputStream

Overrides

com.google.protobuf.GeneratedMessage.writeTo(com.google.protobuf.CodedOutputStream)

Exceptions
Type	Description
IOException