Google Cloud Recommendation Engine V1beta1 Client - Class ImportUserEventsRequest (0.7.4)

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

Request message for the ImportUserEvents request.

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

Namespace

Google \ Cloud \ RecommendationEngine \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

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

↳ request_id string

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.

↳ input_config Google\Cloud\RecommendationEngine\V1beta1\InputConfig

Required. The desired input location of the data.

↳ errors_config Google\Cloud\RecommendationEngine\V1beta1\ImportErrorsConfig

Optional. The desired location of errors incurred during the Import.

getParent

Required.

projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store

Returns
Type Description
string

setParent

Required.

projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store

Parameter
Name Description
var string
Returns
Type Description
$this

getRequestId

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations.

Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.

Returns
Type Description
string

setRequestId

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations.

Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.

Parameter
Name Description
var string
Returns
Type Description
$this

getInputConfig

Required. The desired input location of the data.

Returns
Type Description
Google\Cloud\RecommendationEngine\V1beta1\InputConfig|null

hasInputConfig

clearInputConfig

setInputConfig

Required. The desired input location of the data.

Parameter
Name Description
var Google\Cloud\RecommendationEngine\V1beta1\InputConfig
Returns
Type Description
$this

getErrorsConfig

Optional. The desired location of errors incurred during the Import.

Returns
Type Description
Google\Cloud\RecommendationEngine\V1beta1\ImportErrorsConfig|null

hasErrorsConfig

clearErrorsConfig

setErrorsConfig

Optional. The desired location of errors incurred during the Import.

Parameter
Name Description
var Google\Cloud\RecommendationEngine\V1beta1\ImportErrorsConfig
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store Please see Google\Cloud\RecommendationEngine\V1beta1\UserEventServiceClient::eventStoreName() for help formatting this field.

requestId string

Optional. Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency for expensive long running operations. Server-generated if unspecified. Up to 128 characters long. This is returned as google.longrunning.Operation.name in the response. Note that this field must not be set if the desired input config is catalog_inline_source.

inputConfig Google\Cloud\RecommendationEngine\V1beta1\InputConfig

Required. The desired input location of the data.

errorsConfig Google\Cloud\RecommendationEngine\V1beta1\ImportErrorsConfig

Optional. The desired location of errors incurred during the Import.

Returns
Type Description
Google\Cloud\RecommendationEngine\V1beta1\ImportUserEventsRequest