Google Cloud Recommendation Engine V1beta1 Client - Class WriteUserEventRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Recommendation Engine V1beta1 Client class WriteUserEventRequest.

Request message for WriteUserEvent method.

Generated from protobuf message google.cloud.recommendationengine.v1beta1.WriteUserEventRequest

Methods

build

Parameters
NameDescription
parent string

Required. The parent eventStore resource name, such as projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store. Please see {@see \Google\Cloud\RecommendationEngine\V1beta1\UserEventServiceClient::eventStoreName()} for help formatting this field.

userEvent Google\Cloud\RecommendationEngine\V1beta1\UserEvent

Required. User event to write.

Returns
TypeDescription
Google\Cloud\RecommendationEngine\V1beta1\WriteUserEventRequest

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ user_event Google\Cloud\RecommendationEngine\V1beta1\UserEvent

Required. User event to write.

getParent

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

Returns
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getUserEvent

Required. User event to write.

Returns
TypeDescription
Google\Cloud\RecommendationEngine\V1beta1\UserEvent|null

hasUserEvent

clearUserEvent

setUserEvent

Required. User event to write.

Parameter
NameDescription
var Google\Cloud\RecommendationEngine\V1beta1\UserEvent
Returns
TypeDescription
$this