public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
Document captures all raw metadata information of items to be recommended or
searched.
Protobuf type google.cloud.discoveryengine.v1beta.Document
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DERIVED_STRUCT_DATA_FIELD_NUMBER
public static final int DERIVED_STRUCT_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INDEX_STATUS_FIELD_NUMBER
public static final int INDEX_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INDEX_TIME_FIELD_NUMBER
public static final int INDEX_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
JSON_DATA_FIELD_NUMBER
public static final int JSON_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_DOCUMENT_ID_FIELD_NUMBER
public static final int PARENT_DOCUMENT_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SCHEMA_ID_FIELD_NUMBER
public static final int SCHEMA_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STRUCT_DATA_FIELD_NUMBER
public static final int STRUCT_DATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Document.Builder newBuilder()
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
| Parameter |
| Name |
Description |
prototype |
Document
|
public static Document parseDelimitedFrom(InputStream input)
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(CodedInputStream input)
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(InputStream input)
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Document> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getContent()
public 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;
getContentOrBuilder()
public 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;
getDataCase()
public Document.DataCase getDataCase()
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
getDerivedStructData()
public 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 |
| Type |
Description |
Struct |
The derivedStructData.
|
getDerivedStructDataOrBuilder()
public 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];
getId()
Immutable. The identifier of the document.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
String |
The id.
|
getIdBytes()
public ByteString getIdBytes()
Immutable. The identifier of the document.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
ByteString |
The bytes for id.
|
getIndexStatus()
public 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];
getIndexStatusOrBuilder()
public 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];
getIndexTime()
public 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 |
| Type |
Description |
Timestamp |
The indexTime.
|
getIndexTimeOrBuilder()
public 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];
getJsonData()
public String getJsonData()
The JSON string representation of the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
string json_data = 5;
| Returns |
| Type |
Description |
String |
The jsonData.
|
getJsonDataBytes()
public ByteString getJsonDataBytes()
The JSON string representation of the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
string json_data = 5;
| Returns |
| Type |
Description |
ByteString |
The bytes for jsonData.
|
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 |
| Type |
Description |
String |
The name.
|
getNameBytes()
public 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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParentDocumentId()
public String getParentDocumentId()
The identifier of the parent document. Currently supports at most two level
document hierarchy.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string parent_document_id = 7;
| Returns |
| Type |
Description |
String |
The parentDocumentId.
|
getParentDocumentIdBytes()
public ByteString getParentDocumentIdBytes()
The identifier of the parent document. Currently supports at most two level
document hierarchy.
Id should conform to RFC-1034
standard with a length limit of 63 characters.
string parent_document_id = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for parentDocumentId.
|
getParserForType()
public Parser<Document> getParserForType()
Overrides
getSchemaId()
public String getSchemaId()
The identifier of the schema located in the same data store.
string schema_id = 3;
| Returns |
| Type |
Description |
String |
The schemaId.
|
getSchemaIdBytes()
public ByteString getSchemaIdBytes()
The identifier of the schema located in the same data store.
string schema_id = 3;
| Returns |
| Type |
Description |
ByteString |
The bytes for schemaId.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStructData()
public Struct getStructData()
The structured JSON data for the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
| Returns |
| Type |
Description |
Struct |
The structData.
|
getStructDataOrBuilder()
public StructOrBuilder getStructDataOrBuilder()
The structured JSON data for the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
hasContent()
public 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 |
| Type |
Description |
boolean |
Whether the content field is set.
|
hasDerivedStructData()
public 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 |
| Type |
Description |
boolean |
Whether the derivedStructData field is set.
|
hasIndexStatus()
public 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 |
| Type |
Description |
boolean |
Whether the indexStatus field is set.
|
hasIndexTime()
public 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 |
| Type |
Description |
boolean |
Whether the indexTime field is set.
|
hasJsonData()
public boolean hasJsonData()
The JSON string representation of the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
string json_data = 5;
| Returns |
| Type |
Description |
boolean |
Whether the jsonData field is set.
|
hasStructData()
public boolean hasStructData()
The structured JSON data for the document. It should conform to the
registered Schema or an
INVALID_ARGUMENT error is thrown.
.google.protobuf.Struct struct_data = 4;
| Returns |
| Type |
Description |
boolean |
Whether the structData field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Document.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Document.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
