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 knowledge document to be used by a
 [KnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBase].
 For more information, see the [knowledge base
 guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases).
 Note: The `projects.agent.knowledgeBases.documents` resource is deprecated;
 only use `projects.knowledgeBases.documents`.
 

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 knowledge document to be used by a [KnowledgeBase][google.cloud.dialogflow.v2beta1.KnowledgeBase].
static class	Document.KnowledgeType The knowledge type of document content.
static class	Document.ReloadStatus The status of a reload attempt.
static interface	Document.ReloadStatusOrBuilder
static class	Document.SourceCase
static class	Document.State Possible states of the document

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

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	ENABLE_AUTO_RELOAD_FIELD_NUMBER
static int	KNOWLEDGE_TYPES_FIELD_NUMBER
static int	LATEST_RELOAD_STATUS_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER
static int	MIME_TYPE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	RAW_CONTENT_FIELD_NUMBER
static int	STATE_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	containsMetadata(String key) Optional.
boolean	equals(Object obj)
String	getContent() Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
com.google.protobuf.ByteString	getContentBytes() Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
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.
boolean	getEnableAutoReload() Optional.
Document.KnowledgeType	getKnowledgeTypes(int index) Required.
int	getKnowledgeTypesCount() Required.
List<Document.KnowledgeType>	getKnowledgeTypesList() Required.
int	getKnowledgeTypesValue(int index) Required.
List<Integer>	getKnowledgeTypesValueList() Required.
Document.ReloadStatus	getLatestReloadStatus() Output only.
Document.ReloadStatusOrBuilder	getLatestReloadStatusOrBuilder() Output only.
Map<String,String>	getMetadata() Deprecated.
int	getMetadataCount() Optional.
Map<String,String>	getMetadataMap() Optional.
String	getMetadataOrDefault(String key, String defaultValue) Optional.
String	getMetadataOrThrow(String key) Optional.
String	getMimeType() Required.
com.google.protobuf.ByteString	getMimeTypeBytes() Required.
String	getName() Optional.
com.google.protobuf.ByteString	getNameBytes() Optional.
com.google.protobuf.Parser<Document>	getParserForType()
com.google.protobuf.ByteString	getRawContent() The raw content of the document.
int	getSerializedSize()
Document.SourceCase	getSourceCase()
Document.State	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasContent() Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357
boolean	hasContentUri() The URI where the file content is located.
int	hashCode()
boolean	hasLatestReloadStatus() Output only.
boolean	hasRawContent() The raw content of the document.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
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)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
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, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, 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

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

RAW_CONTENT_FIELD_NUMBER

public static final int RAW_CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_AUTO_RELOAD_FIELD_NUMBER

public static final int ENABLE_AUTO_RELOAD_FIELD_NUMBER

See Also:

Constant Field Values

LATEST_RELOAD_STATUS_FIELD_NUMBER

public static final int LATEST_RELOAD_STATUS_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

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()

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

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

Specified by:

getName in interface DocumentOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

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

Specified by:

getNameBytes in interface DocumentOrBuilder

Returns:

The bytes for name.

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface DocumentOrBuilder

Returns:

The displayName.

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 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface DocumentOrBuilder

Returns:

The bytes for displayName.

getMimeType

public String getMimeType()

 Required. The MIME type of this document.
 

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getMimeType in interface DocumentOrBuilder

Returns:

The mimeType.

getMimeTypeBytes

public com.google.protobuf.ByteString getMimeTypeBytes()

 Required. The MIME type of this document.
 

string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getMimeTypeBytes in interface DocumentOrBuilder

Returns:

The bytes for mimeType.

getKnowledgeTypesList

public List<Document.KnowledgeType> getKnowledgeTypesList()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKnowledgeTypesList in interface DocumentOrBuilder

Returns:

A list containing the knowledgeTypes.

getKnowledgeTypesCount

public int getKnowledgeTypesCount()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKnowledgeTypesCount in interface DocumentOrBuilder

Returns:

The count of knowledgeTypes.

getKnowledgeTypes

public Document.KnowledgeType getKnowledgeTypes(int index)

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKnowledgeTypes in interface DocumentOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The knowledgeTypes at the given index.

getKnowledgeTypesValueList

public List<Integer> getKnowledgeTypesValueList()

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKnowledgeTypesValueList in interface DocumentOrBuilder

Returns:

A list containing the enum numeric values on the wire for knowledgeTypes.

getKnowledgeTypesValue

public int getKnowledgeTypesValue(int index)

 Required. The knowledge type of document content.
 

repeated .google.cloud.dialogflow.v2beta1.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getKnowledgeTypesValue in interface DocumentOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of knowledgeTypes at the given index.

hasContentUri

public boolean hasContentUri()

 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:

hasContentUri in interface DocumentOrBuilder

Returns:

Whether the contentUri field is set.

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

Returns:

The contentUri.

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

Returns:

The bytes for contentUri.

hasContent

@Deprecated
public boolean hasContent()

Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357

 The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
 

string content = 6 [deprecated = true];

Specified by:

hasContent in interface DocumentOrBuilder

Returns:

Whether the content field is set.

getContent

@Deprecated
public String getContent()

Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357

 The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
 

string content = 6 [deprecated = true];

Specified by:

getContent in interface DocumentOrBuilder

Returns:

The content.

getContentBytes

@Deprecated
public com.google.protobuf.ByteString getContentBytes()

Deprecated. google.cloud.dialogflow.v2beta1.Document.content is deprecated. See google/cloud/dialogflow/v2beta1/document.proto;l=357

 The raw content of the document. This field is only permitted for
 EXTRACTIVE_QA and FAQ knowledge types.
 Note: This field is in the process of being deprecated, please use
 raw_content instead.
 

string content = 6 [deprecated = true];

Specified by:

getContentBytes in interface DocumentOrBuilder

Returns:

The bytes for content.

hasRawContent

public boolean hasRawContent()

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

bytes raw_content = 9;

Specified by:

hasRawContent in interface DocumentOrBuilder

Returns:

Whether the rawContent field is set.

getRawContent

public com.google.protobuf.ByteString getRawContent()

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

bytes raw_content = 9;

Specified by:

getRawContent in interface DocumentOrBuilder

Returns:

The rawContent.

getEnableAutoReload

public boolean getEnableAutoReload()

 Optional. If true, we try to automatically reload the document every day
 (at a time picked by the system). If false or unspecified, we don't try
 to automatically reload the document.
 Currently you can only enable automatic reload for documents sourced from
 a public url, see `source` field for the source types.
 Reload status can be tracked in `latest_reload_status`. If a reload
 fails, we will keep the document unchanged.
 If a reload fails with internal errors, the system will try to reload the
 document on the next day.
 If a reload fails with non-retriable errors (e.g. PERMISSION_DENIED), the
 system will not try to reload the document anymore. You need to manually
 reload the document successfully by calling `ReloadDocument` and clear the
 errors.
 

bool enable_auto_reload = 11 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getEnableAutoReload in interface DocumentOrBuilder

Returns:

The enableAutoReload.

hasLatestReloadStatus

public boolean hasLatestReloadStatus()

 Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
 

.google.cloud.dialogflow.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

hasLatestReloadStatus in interface DocumentOrBuilder

Returns:

Whether the latestReloadStatus field is set.

getLatestReloadStatus

public Document.ReloadStatus getLatestReloadStatus()

 Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
 

.google.cloud.dialogflow.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getLatestReloadStatus in interface DocumentOrBuilder

Returns:

The latestReloadStatus.

getLatestReloadStatusOrBuilder

public Document.ReloadStatusOrBuilder getLatestReloadStatusOrBuilder()

 Output only. The time and status of the latest reload.
 This reload may have been triggered automatically or manually
 and may not have succeeded.
 

.google.cloud.dialogflow.v2beta1.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getLatestReloadStatusOrBuilder in interface DocumentOrBuilder

getMetadataCount

public int getMetadataCount()

Description copied from interface: DocumentOrBuilder

 Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
 

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMetadataCount in interface DocumentOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
 

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

containsMetadata in interface DocumentOrBuilder

getMetadata

@Deprecated
public Map<String,String> getMetadata()

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface DocumentOrBuilder

getMetadataMap

public Map<String,String> getMetadataMap()

 Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
 

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMetadataMap in interface DocumentOrBuilder

getMetadataOrDefault

public String getMetadataOrDefault(String key,
                                   String defaultValue)

 Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
 

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMetadataOrDefault in interface DocumentOrBuilder

getMetadataOrThrow

public String getMetadataOrThrow(String key)

 Optional. Metadata for the document. The metadata supports arbitrary
 key-value pairs. Suggested use cases include storing a document's title,
 an external URL distinct from the document's content_uri, etc.
 The max size of a `key` or a `value` of the metadata is 1024 bytes.
 

map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getMetadataOrThrow in interface DocumentOrBuilder

getStateValue

public int getStateValue()

 Output only. The current state of the document.
 

.google.cloud.dialogflow.v2beta1.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getStateValue in interface DocumentOrBuilder

Returns:

The enum numeric value on the wire for state.

getState

public Document.State getState()

 Output only. The current state of the document.
 

.google.cloud.dialogflow.v2beta1.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getState in interface DocumentOrBuilder

Returns:

The state.

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