public sealed class WriteUserEventRequest : IMessage<WriteUserEventRequest>, IEquatable<WriteUserEventRequest>, IDeepCloneable<WriteUserEventRequest>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class WriteUserEventRequest.
Request message for WriteUserEvent method.
Implements
IMessageWriteUserEventRequest, IEquatableWriteUserEventRequest, IDeepCloneableWriteUserEventRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
WriteUserEventRequest()
public WriteUserEventRequest()
WriteUserEventRequest(WriteUserEventRequest)
public WriteUserEventRequest(WriteUserEventRequest other)
Parameter | |
---|---|
Name | Description |
other |
WriteUserEventRequest |
Properties
Parent
public string Parent { get; set; }
Required. The parent resource name.
If the write user event action is applied in
[DataStore][google.cloud.discoveryengine.v1.DataStore] level, the format
is:
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}
.
If the write user event action is applied in [Location][] level, for
example, the event with
[Document][google.cloud.discoveryengine.v1.Document] across multiple
[DataStore][google.cloud.discoveryengine.v1.DataStore], the format is:
projects/{project}/locations/{location}
.
Property Value | |
---|---|
Type | Description |
string |
ParentAsDataStoreName
public DataStoreName ParentAsDataStoreName { get; set; }
DataStoreName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
DataStoreName |
UserEvent
public UserEvent UserEvent { get; set; }
Required. User event to write.
Property Value | |
---|---|
Type | Description |
UserEvent |
WriteAsync
public bool WriteAsync { get; set; }
If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.
Property Value | |
---|---|
Type | Description |
bool |