com.google.cloud.discoveryengine.v1beta

Interface DocumentOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Document, Document.Builder

public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Document.Content	getContent() The unstructured data linked to this document.
Document.ContentOrBuilder	getContentOrBuilder() The unstructured data linked to this document.
Document.DataCase	getDataCase()
com.google.protobuf.Struct	getDerivedStructData() Output only.
com.google.protobuf.StructOrBuilder	getDerivedStructDataOrBuilder() Output only.
String	getId() Immutable.
com.google.protobuf.ByteString	getIdBytes() Immutable.
Document.IndexStatus	getIndexStatus() Output only.
Document.IndexStatusOrBuilder	getIndexStatusOrBuilder() Output only.
com.google.protobuf.Timestamp	getIndexTime() Output only.
com.google.protobuf.TimestampOrBuilder	getIndexTimeOrBuilder() Output only.
String	getJsonData() The JSON string representation of the document.
com.google.protobuf.ByteString	getJsonDataBytes() The JSON string representation of the document.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
String	getParentDocumentId() The identifier of the parent document.
com.google.protobuf.ByteString	getParentDocumentIdBytes() The identifier of the parent document.
String	getSchemaId() The identifier of the schema located in the same data store.
com.google.protobuf.ByteString	getSchemaIdBytes() The identifier of the schema located in the same data store.
com.google.protobuf.Struct	getStructData() The structured JSON data for the document.
com.google.protobuf.StructOrBuilder	getStructDataOrBuilder() The structured JSON data for the document.
boolean	hasContent() The unstructured data linked to this document.
boolean	hasDerivedStructData() Output only.
boolean	hasIndexStatus() Output only.
boolean	hasIndexTime() Output only.
boolean	hasJsonData() The JSON string representation of the document.
boolean	hasStructData() The structured JSON data for the document.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasStructData

boolean hasStructData()

 The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

.google.protobuf.Struct struct_data = 4;

Returns:

Whether the structData field is set.

getStructData

com.google.protobuf.Struct getStructData()

 The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

.google.protobuf.Struct struct_data = 4;

Returns:

The structData.

getStructDataOrBuilder

com.google.protobuf.StructOrBuilder getStructDataOrBuilder()

 The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

.google.protobuf.Struct struct_data = 4;

hasJsonData

boolean hasJsonData()

 The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

string json_data = 5;

Returns:

Whether the jsonData field is set.

getJsonData

String getJsonData()

 The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

string json_data = 5;

Returns:

The jsonData.

getJsonDataBytes

com.google.protobuf.ByteString getJsonDataBytes()

 The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
 

string json_data = 5;

Returns:

The bytes for jsonData.

getName

String getName()

 Immutable. The full resource name of the document.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Immutable. The full resource name of the document.
 Format:
 `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`.

 This field must be a UTF-8 encoded string with a length limit of 1024
 characters.
 

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

Returns:

The bytes for name.

getId

String getId()

 Immutable. The identifier of the document.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Immutable. The identifier of the document.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The bytes for id.

getSchemaId

String getSchemaId()

 The identifier of the schema located in the same data store.
 

string schema_id = 3;

Returns:

The schemaId.

getSchemaIdBytes

com.google.protobuf.ByteString getSchemaIdBytes()

 The identifier of the schema located in the same data store.
 

string schema_id = 3;

Returns:

The bytes for schemaId.

hasContent

boolean hasContent()

 The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
 

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns:

Whether the content field is set.

getContent

Document.Content getContent()

 The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
 

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns:

The content.

getContentOrBuilder

Document.ContentOrBuilder getContentOrBuilder()

 The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
 

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

getParentDocumentId

String getParentDocumentId()

 The identifier of the parent document. Currently supports at most two level
 document hierarchy.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string parent_document_id = 7;

Returns:

The parentDocumentId.

getParentDocumentIdBytes

com.google.protobuf.ByteString getParentDocumentIdBytes()

 The identifier of the parent document. Currently supports at most two level
 document hierarchy.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
 

string parent_document_id = 7;

Returns:

The bytes for parentDocumentId.

hasDerivedStructData

boolean hasDerivedStructData()

 Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
 

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the derivedStructData field is set.

getDerivedStructData

com.google.protobuf.Struct getDerivedStructData()

 Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
 

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The derivedStructData.

getDerivedStructDataOrBuilder

com.google.protobuf.StructOrBuilder getDerivedStructDataOrBuilder()

 Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
 

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasIndexTime

boolean hasIndexTime()

 Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
 

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the indexTime field is set.

getIndexTime

com.google.protobuf.Timestamp getIndexTime()

 Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
 

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The indexTime.

getIndexTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getIndexTimeOrBuilder()

 Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
 

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasIndexStatus

boolean hasIndexStatus()

 Output only. The index status of the document.

 * If document is indexed successfully, the index_time field is populated.
 * Otherwise, if document is not indexed due to errors, the error_samples
   field is populated.
 * Otherwise, index_status is unset.
 

.google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the indexStatus field is set.

getIndexStatus

Document.IndexStatus getIndexStatus()

 Output only. The index status of the document.

 * If document is indexed successfully, the index_time field is populated.
 * Otherwise, if document is not indexed due to errors, the error_samples
   field is populated.
 * Otherwise, index_status is unset.
 

.google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The indexStatus.

getIndexStatusOrBuilder

Document.IndexStatusOrBuilder getIndexStatusOrBuilder()

 Output only. The index status of the document.

 * If document is indexed successfully, the index_time field is populated.
 * Otherwise, if document is not indexed due to errors, the error_samples
   field is populated.
 * Otherwise, index_status is unset.
 

.google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

getDataCase

Document.DataCase getDataCase()