Class GoogleCloudDiscoveryengineV1alphaDocument
Document captures all raw metadata information of items to be recommended or searched.
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1alpha.Data
Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaDocument : IDirectResponseSchema
Properties
AclInfo
Access control information for the document.
Declaration
[JsonProperty("aclInfo")]
public virtual GoogleCloudDiscoveryengineV1alphaDocumentAclInfo AclInfo { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaDocumentAclInfo |
Content
The unstructured data linked to this document. Content must be set if this document is under a
CONTENT_REQUIRED
data store.
Declaration
[JsonProperty("content")]
public virtual GoogleCloudDiscoveryengineV1alphaDocumentContent Content { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaDocumentContent |
DerivedStructData
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
Declaration
[JsonProperty("derivedStructData")]
public virtual IDictionary<string, object> DerivedStructData { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, object> |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
Id
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
Declaration
[JsonProperty("id")]
public virtual string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
IndexStatus
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.
Declaration
[JsonProperty("indexStatus")]
public virtual GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus IndexStatus { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaDocumentIndexStatus |
IndexTime
object representation of IndexTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use IndexTimeDateTimeOffset instead.")]
public virtual object IndexTime { get; set; }
Property Value
Type | Description |
---|---|
object |
IndexTimeDateTimeOffset
DateTimeOffset representation of IndexTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? IndexTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
IndexTimeRaw
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.
Declaration
[JsonProperty("indexTime")]
public virtual string IndexTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
JsonData
The JSON string representation of the document. It should conform to the registered Schema or an
INVALID_ARGUMENT
error is thrown.
Declaration
[JsonProperty("jsonData")]
public virtual string JsonData { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
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.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
ParentDocumentId
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.
Declaration
[JsonProperty("parentDocumentId")]
public virtual string ParentDocumentId { get; set; }
Property Value
Type | Description |
---|---|
string |
SchemaId
The identifier of the schema located in the same data store.
Declaration
[JsonProperty("schemaId")]
public virtual string SchemaId { get; set; }
Property Value
Type | Description |
---|---|
string |
StructData
The structured JSON data for the document. It should conform to the registered Schema or an
INVALID_ARGUMENT
error is thrown.
Declaration
[JsonProperty("structData")]
public virtual IDictionary<string, object> StructData { get; set; }
Property Value
Type | Description |
---|---|
IDictionary<string, object> |