public sealed class DocumentInfo : IMessage<DocumentInfo>, IEquatable<DocumentInfo>, IDeepCloneable<DocumentInfo>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1beta API class DocumentInfo.
Detailed document information associated with a user event.
Implements
IMessageDocumentInfo, IEquatableDocumentInfo, IDeepCloneableDocumentInfo, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
Google.Cloud.DiscoveryEngine.V1Beta.dll
Constructors
DocumentInfo()
public DocumentInfo()DocumentInfo(DocumentInfo)
public DocumentInfo(DocumentInfo other)| Parameter | |
|---|---|
| Name | Description |
other |
DocumentInfo |
Properties
DocumentDescriptorCase
public DocumentInfo.DocumentDescriptorOneofCase DocumentDescriptorCase { get; }| Property Value | |
|---|---|
| Type | Description |
DocumentInfoDocumentDescriptorOneofCase |
|
DocumentName
public DocumentName DocumentName { get; set; }DocumentName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
DocumentName |
|
HasId
public bool HasId { get; }Gets whether the "id" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasName
public bool HasName { get; }Gets whether the "name" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasQuantity
public bool HasQuantity { get; }Gets whether the "quantity" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
HasUri
public bool HasUri { get; }Gets whether the "uri" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Id
public string Id { get; set; }The [Document][google.cloud.discoveryengine.v1beta.Document] resource ID.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Joined
public bool Joined { get; set; }Output only. Whether the referenced Document can be found in the data store.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
Name
public string Name { get; set; }The [Document][google.cloud.discoveryengine.v1beta.Document] resource
full name, of the form:
projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}
| Property Value | |
|---|---|
| Type | Description |
string |
|
PromotionIds
public RepeatedField<string> PromotionIds { get; }The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
Quantity
public int Quantity { get; set; }Quantity of the Document associated with the user event. Defaults to 1.
For example, this field is 2 if two quantities of the same Document
are involved in a add-to-cart event.
Required for events of the following event types:
add-to-cartpurchase
| Property Value | |
|---|---|
| Type | Description |
int |
|
Uri
public string Uri { get; set; }The [Document][google.cloud.discoveryengine.v1beta.Document] URI - only allowed for website data stores.
| Property Value | |
|---|---|
| Type | Description |
string |
|