Google Cloud Retail V2 Client - Class WriteUserEventRequest (1.3.1)

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

↳ 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
TypeDescription
string

setParent

Required. The parent catalog resource name, such as projects/1234/locations/global/catalogs/default_catalog.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserEvent

Required. User event to write.

Returns
TypeDescription
Google\Cloud\Retail\V2\UserEvent|null

hasUserEvent

clearUserEvent

setUserEvent

Required. User event to write.

Parameter
NameDescription
var Google\Cloud\Retail\V2\UserEvent
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this