Google Cloud Retail V2 Client - Class WriteUserEventRequest (1.0.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

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.

getParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
string

setParent

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

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserEvent

Required. User event to write.

Generated from protobuf field .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

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

hasUserEvent

clearUserEvent

setUserEvent

Required. User event to write.

Generated from protobuf field .google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Retail\V2\UserEvent
Returns
TypeDescription
$this