Google Cloud Retail V2 Client - Class ImportUserEventsRequest (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class ImportUserEventsRequest.

Request message for the ImportUserEvents request.

Generated from protobuf message google.cloud.retail.v2.ImportUserEventsRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. projects/1234/locations/global/catalogs/default_catalog

↳ input_config Google\Cloud\Retail\V2\UserEventInputConfig

Required. The desired input location of the data.

↳ errors_config Google\Cloud\Retail\V2\ImportErrorsConfig

The desired location of errors incurred during the Import. Cannot be set for inline user event imports.

getParent

Required. projects/1234/locations/global/catalogs/default_catalog

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

Required. projects/1234/locations/global/catalogs/default_catalog

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInputConfig

Required. The desired input location of the data.

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

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

hasInputConfig

clearInputConfig

setInputConfig

Required. The desired input location of the data.

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

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

getErrorsConfig

The desired location of errors incurred during the Import. Cannot be set for inline user event imports.

Generated from protobuf field .google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;

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

hasErrorsConfig

clearErrorsConfig

setErrorsConfig

The desired location of errors incurred during the Import. Cannot be set for inline user event imports.

Generated from protobuf field .google.cloud.retail.v2.ImportErrorsConfig errors_config = 3;

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