Google Cloud Retail V2 Client - Class ImportProductsRequest (1.5.0)

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

Request message for Import methods.

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

Namespace

Google \ Cloud \ Retail \ V2

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. projects/1234/locations/global/catalogs/default_catalog/branches/default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

↳ request_id string

Deprecated. This field has no effect.

↳ input_config Google\Cloud\Retail\V2\ProductInputConfig

Required. The desired input location of the data.

↳ errors_config Google\Cloud\Retail\V2\ImportErrorsConfig

The desired location of errors incurred during the Import.

↳ update_mask Google\Protobuf\FieldMask

Indicates which fields in the provided imported products to update. If not set, all fields are updated.

↳ reconciliation_mode int

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

↳ notification_pubsub_topic string

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that service-<project number>@gcp-sa-retail.iam.gserviceaccount.com has the pubsub.topics.publish IAM permission on the topic.

getParent

Required.

projects/1234/locations/global/catalogs/default_catalog/branches/default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

Returns
TypeDescription
string

setParent

Required.

projects/1234/locations/global/catalogs/default_catalog/branches/default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getRequestId

Deprecated. This field has no effect.

Returns
TypeDescription
string

setRequestId

Deprecated. This field has no effect.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInputConfig

Required. The desired input location of the data.

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

hasInputConfig

clearInputConfig

setInputConfig

Required. The desired input location of the data.

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

getErrorsConfig

The desired location of errors incurred during the Import.

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

hasErrorsConfig

clearErrorsConfig

setErrorsConfig

The desired location of errors incurred during the Import.

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

getUpdateMask

Indicates which fields in the provided imported products to update. If not set, all fields are updated.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Indicates which fields in the provided imported products to update. If not set, all fields are updated.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

getReconciliationMode

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns
TypeDescription
int

setReconciliationMode

The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNotificationPubsubTopic

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation.

Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that service-<project number>@gcp-sa-retail.iam.gserviceaccount.com has the pubsub.topics.publish IAM permission on the topic.

Returns
TypeDescription
string

setNotificationPubsubTopic

Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation.

Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that service-<project number>@gcp-sa-retail.iam.gserviceaccount.com has the pubsub.topics.publish IAM permission on the topic.

Parameter
NameDescription
var string
Returns
TypeDescription
$this