Reference documentation and code samples for the Google Cloud Retail V2 Client class WriteUserEventRequest.
Request message for WriteUserEvent method.
Generated from protobuf message google.cloud.retail.v2.WriteUserEventRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent catalog resource name, such as |
↳ user_event |
Google\Cloud\Retail\V2\UserEvent
Required. User event to write. |
↳ write_async |
bool
If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write. Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs. |
getParent
Required. The parent catalog resource name, such as
projects/1234/locations/global/catalogs/default_catalog.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The parent catalog resource name, such as
projects/1234/locations/global/catalogs/default_catalog.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getUserEvent
Required. User event to write.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Retail\V2\UserEvent|null | |
hasUserEvent
clearUserEvent
setUserEvent
Required. User event to write.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Retail\V2\UserEvent
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getWriteAsync
If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write.
Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
| Returns | |
|---|---|
| Type | Description |
bool | |
setWriteAsync
If set to true, the user event will be written asynchronously after validation, and the API will respond without waiting for the write.
Therefore, silent failures can occur even if the API returns success. In case of silent failures, error messages can be found in Stackdriver logs.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |