Google Cloud Discovery Engine V1 Client - Class WriteUserEventRequest (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class WriteUserEventRequest.

Request message for WriteUserEvent method.

Generated from protobuf message google.cloud.discoveryengine.v1.WriteUserEventRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent resource name. If the write user event action is applied in 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 across multiple DataStore, the format is: projects/{project}/locations/{location}.
↳ user_event Google\Cloud\DiscoveryEngine\V1\UserEvent

Required. User event to write.
↳ write_async bool

If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

getParent

Required. The parent resource name.

If the write user event action is applied in 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 across multiple DataStore, the format is: projects/{project}/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent resource name.

If the write user event action is applied in 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 across multiple DataStore, the format is: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUserEvent

Required. User event to write.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\UserEvent|null

hasUserEvent

clearUserEvent

setUserEvent

Required. User event to write.

Parameter
Name Description
var Google\Cloud\DiscoveryEngine\V1\UserEvent
Returns
Type Description
$this

getWriteAsync

If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

Returns
Type Description
bool

setWriteAsync

If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.

Parameter
Name Description
var bool
Returns
Type Description
$this