public final class Document extends com.google.protobuf.GeneratedMessageV3 implements DocumentOrBuilder
Document captures all raw metadata information of items to be recommended or searched.Protobuf type
google.cloud.discoveryengine.v1alpha.Document| Modifier and Type | Class and Description |
|---|---|
static class |
Document.AclInfo
ACL Information of the Document.
|
static interface |
Document.AclInfoOrBuilder |
static class |
Document.Builder
Document captures all raw metadata information of items to be recommended or
searched.
|
static class |
Document.Content
Unstructured data linked to this document.
|
static interface |
Document.ContentOrBuilder |
static class |
Document.DataCase |
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| Modifier and Type | Field and Description |
|---|---|
static int |
ACL_INFO_FIELD_NUMBER |
static int |
CONTENT_FIELD_NUMBER |
static int |
DERIVED_STRUCT_DATA_FIELD_NUMBER |
static int |
ID_FIELD_NUMBER |
static int |
INDEX_TIME_FIELD_NUMBER |
static int |
JSON_DATA_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
PARENT_DOCUMENT_ID_FIELD_NUMBER |
static int |
SCHEMA_ID_FIELD_NUMBER |
static int |
STRUCT_DATA_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Document.AclInfo |
getAclInfo()
Access control information for the document.
|
Document.AclInfoOrBuilder |
getAclInfoOrBuilder()
Access control information for the document.
|
Document.Content |
getContent()
The unstructured data linked to this document.
|
Document.ContentOrBuilder |
getContentOrBuilder()
The unstructured data linked to this document.
|
Document.DataCase |
getDataCase() |
static Document |
getDefaultInstance() |
Document |
getDefaultInstanceForType() |
com.google.protobuf.Struct |
getDerivedStructData()
Output only.
|
com.google.protobuf.StructOrBuilder |
getDerivedStructDataOrBuilder()
Output only.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getId()
Immutable.
|
com.google.protobuf.ByteString |
getIdBytes()
Immutable.
|
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.
|
com.google.protobuf.Parser<Document> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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 |
hasAclInfo()
Access control information for the document.
|
boolean |
hasContent()
The unstructured data linked to this document.
|
boolean |
hasDerivedStructData()
Output only.
|
int |
hashCode() |
boolean |
hasIndexTime()
Output only.
|
boolean |
hasJsonData()
The JSON string representation of the document.
|
boolean |
hasStructData()
The structured JSON data for the document.
|
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) |
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) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int STRUCT_DATA_FIELD_NUMBER
public static final int JSON_DATA_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
public static final int SCHEMA_ID_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
public static final int PARENT_DOCUMENT_ID_FIELD_NUMBER
public static final int DERIVED_STRUCT_DATA_FIELD_NUMBER
public static final int ACL_INFO_FIELD_NUMBER
public static final int INDEX_TIME_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Document.DataCase getDataCase()
getDataCase in interface DocumentOrBuilderpublic boolean hasStructData()
The structured JSON data for the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
.google.protobuf.Struct struct_data = 4;hasStructData in interface DocumentOrBuilderpublic com.google.protobuf.Struct getStructData()
The structured JSON data for the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
.google.protobuf.Struct struct_data = 4;getStructData in interface DocumentOrBuilderpublic com.google.protobuf.StructOrBuilder getStructDataOrBuilder()
The structured JSON data for the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
.google.protobuf.Struct struct_data = 4;getStructDataOrBuilder in interface DocumentOrBuilderpublic boolean hasJsonData()
The JSON string representation of the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
string json_data = 5;hasJsonData in interface DocumentOrBuilderpublic String getJsonData()
The JSON string representation of the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
string json_data = 5;getJsonData in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getJsonDataBytes()
The JSON string representation of the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an `INVALID_ARGUMENT` error is thrown.
string json_data = 5;getJsonDataBytes in interface DocumentOrBuilderpublic 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];getName in interface DocumentOrBuilderpublic 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];getNameBytes in interface DocumentOrBuilderpublic 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];getId in interface DocumentOrBuilderpublic 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];getIdBytes in interface DocumentOrBuilderpublic String getSchemaId()
The identifier of the schema located in the same data store.
string schema_id = 3;getSchemaId in interface DocumentOrBuilderpublic com.google.protobuf.ByteString getSchemaIdBytes()
The identifier of the schema located in the same data store.
string schema_id = 3;getSchemaIdBytes in interface DocumentOrBuilderpublic 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.v1alpha.Document.Content content = 10;hasContent in interface DocumentOrBuilderpublic 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.v1alpha.Document.Content content = 10;getContent in interface DocumentOrBuilderpublic 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.v1alpha.Document.Content content = 10;getContentOrBuilder in interface DocumentOrBuilderpublic 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;getParentDocumentId in interface DocumentOrBuilderpublic 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;getParentDocumentIdBytes in interface DocumentOrBuilderpublic 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];
hasDerivedStructData in interface DocumentOrBuilderpublic 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];
getDerivedStructData in interface DocumentOrBuilderpublic 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];
getDerivedStructDataOrBuilder in interface DocumentOrBuilderpublic boolean hasAclInfo()
Access control information for the document.
.google.cloud.discoveryengine.v1alpha.Document.AclInfo acl_info = 11;hasAclInfo in interface DocumentOrBuilderpublic Document.AclInfo getAclInfo()
Access control information for the document.
.google.cloud.discoveryengine.v1alpha.Document.AclInfo acl_info = 11;getAclInfo in interface DocumentOrBuilderpublic Document.AclInfoOrBuilder getAclInfoOrBuilder()
Access control information for the document.
.google.cloud.discoveryengine.v1alpha.Document.AclInfo acl_info = 11;getAclInfoOrBuilder in interface DocumentOrBuilderpublic 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];
hasIndexTime in interface DocumentOrBuilderpublic 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];
getIndexTime in interface DocumentOrBuilderpublic 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];
getIndexTimeOrBuilder in interface DocumentOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Document parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Document parseFrom(InputStream input) throws IOException
IOExceptionpublic static Document parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Document parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Document parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Document parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Document.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Document.Builder newBuilder()
public static Document.Builder newBuilder(Document prototype)
public Document.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Document.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Document getDefaultInstance()
public static com.google.protobuf.Parser<Document> parser()
public com.google.protobuf.Parser<Document> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Document getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.