com.google.cloud.dialogflow.v2beta1

Class Document

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.v2beta1.Document

All Implemented Interfaces:

DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Document
extends com.google.protobuf.GeneratedMessageV3
implements DocumentOrBuilder

 A document resource.
 

Protobuf type google.cloud.dialogflow.v2beta1.Document

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.Builder A document resource.
static class	Document.KnowledgeType The knowledge type of document content.
static class	Document.SourceCase

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	CONTENT_URI_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	KNOWLEDGE_TYPES_FIELD_NUMBER
static int	MIME_TYPE_FIELD_NUMBER
static int	NAME_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(Object obj)
String	getContent() The raw content of the document.
com.google.protobuf.ByteString	getContentBytes() The raw content of the document.
String	getContentUri() The URI where the file content is located.
com.google.protobuf.ByteString	getContentUriBytes() The URI where the file content is located.
static Document	getDefaultInstance()
Document	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Document.KnowledgeType	getKnowledgeTypes(int index) Required.
int	getKnowledgeTypesCount() Required.
List<Document.KnowledgeType>	getKnowledgeTypesList() Required.
int	getKnowledgeTypesValue(int index) Required.
List<Integer>	getKnowledgeTypesValueList() Required.
String	getMimeType() Required.
com.google.protobuf.ByteString	getMimeTypeBytes() Required.
String	getName() The document resource name.
com.google.protobuf.ByteString	getNameBytes() The document resource name.
com.google.protobuf.Parser<Document>	getParserForType()
int	getSerializedSize()
Document.SourceCase	getSourceCase()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Builder	newBuilder()
static Document.Builder	newBuilder(Document prototype)
Document.Builder	newBuilderForType()
protected Document.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Document	parseDelimitedFrom(InputStream input)
static Document	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(byte[] data)
static Document	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(ByteBuffer data)
static Document	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(com.google.protobuf.ByteString data)
static Document	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(com.google.protobuf.CodedInputStream input)
static Document	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(InputStream input)
static Document	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document>	parser()
Document.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

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

KNOWLEDGE_TYPES_FIELD_NUMBER

public static final int KNOWLEDGE_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_URI_FIELD_NUMBER

public static final int CONTENT_URI_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_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

getSourceCase

public Document.SourceCase getSourceCase()

Specified by:

getSourceCase in interface DocumentOrBuilder

getName

public String getName()

 The document resource name.
 The name must be empty when creating a document.
 Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
 ID>/documents/<Document ID>`.
 

string name = 1;

Specified by:

getName in interface DocumentOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The document resource name.
 The name must be empty when creating a document.
 Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base
 ID>/documents/<Document ID>`.
 

string name = 1;

Specified by:

getNameBytes in interface DocumentOrBuilder

getDisplayName

public String getDisplayName()

 Required. The display name of the document. The name must be 1024 bytes or
 less; otherwise, the creation request fails.
 

string display_name = 2;

Specified by:

getDisplayName in interface DocumentOrBuilder

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The display name of the document. The name must be 1024 bytes or
 less; otherwise, the creation request fails.
 

string display_name = 2;

Specified by:

getDisplayNameBytes in interface DocumentOrBuilder

getMimeType

public String getMimeType()

 Required. The MIME type of this document.
 

string mime_type = 3;

Specified by:

getMimeType in interface DocumentOrBuilder

getMimeTypeBytes

public com.google.protobuf.ByteString getMimeTypeBytes()

 Required. The MIME type of this document.
 

string mime_type = 3;

Specified by:

getMimeTypeBytes in interface DocumentOrBuilder

getKnowledgeTypesList

public List<Document.KnowledgeType> getKnowledgeTypesList()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4;

Specified by:

getKnowledgeTypesList in interface DocumentOrBuilder

getKnowledgeTypesCount

public int getKnowledgeTypesCount()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4;

Specified by:

getKnowledgeTypesCount in interface DocumentOrBuilder

getKnowledgeTypes

public Document.KnowledgeType getKnowledgeTypes(int index)

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4;

Specified by:

getKnowledgeTypes in interface DocumentOrBuilder

getKnowledgeTypesValueList

public List<Integer> getKnowledgeTypesValueList()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4;

Specified by:

getKnowledgeTypesValueList in interface DocumentOrBuilder

getKnowledgeTypesValue

public int getKnowledgeTypesValue(int index)

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4;

Specified by:

getKnowledgeTypesValue in interface DocumentOrBuilder

getContentUri

public String getContentUri()

 The URI where the file content is located.
 For documents stored in Google Cloud Storage, these URIs must have
 the form `gs://<bucket-name>/<object-name>`.
 NOTE: External URLs must correspond to public webpages, i.e., they must
 be indexed by Google Search. In particular, URLs for showing documents in
 Google Cloud Storage (i.e. the URL in your browser) are not supported.
 Instead use the `gs://` format URI described above.
 

string content_uri = 5;

Specified by:

getContentUri in interface DocumentOrBuilder

getContentUriBytes

public com.google.protobuf.ByteString getContentUriBytes()

 The URI where the file content is located.
 For documents stored in Google Cloud Storage, these URIs must have
 the form `gs://<bucket-name>/<object-name>`.
 NOTE: External URLs must correspond to public webpages, i.e., they must
 be indexed by Google Search. In particular, URLs for showing documents in
 Google Cloud Storage (i.e. the URL in your browser) are not supported.
 Instead use the `gs://` format URI described above.
 

string content_uri = 5;

Specified by:

getContentUriBytes in interface DocumentOrBuilder

getContent

public String getContent()

 The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 

string content = 6;

Specified by:

getContent in interface DocumentOrBuilder

getContentBytes

public com.google.protobuf.ByteString getContentBytes()

 The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 

string content = 6;

Specified by:

getContentBytes in interface DocumentOrBuilder

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 IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

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(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 Document parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Document parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Document parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Document.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.Builder newBuilder()

newBuilder

public static Document.Builder newBuilder(Document prototype)

toBuilder

public Document.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Document> 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 Document getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder