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 \ V2Methods
__construct
Constructor.
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
↳ 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. If provided, only the existing product fields are updated. Missing products will not be created.
↳ 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 both cloud-retail-customer-data-access@system.gserviceaccount.com
and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com
have the pubsub.topics.publish
IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode
is set to FULL
.
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.
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.
var
string
$this
getRequestId
Deprecated. This field has no effect.
string
setRequestId
Deprecated. This field has no effect.
var
string
$this
getInputConfig
Required. The desired input location of the data.
hasInputConfig
clearInputConfig
setInputConfig
Required. The desired input location of the data.
$this
getErrorsConfig
The desired location of errors incurred during the Import.
hasErrorsConfig
clearErrorsConfig
setErrorsConfig
The desired location of errors incurred during the Import.
$this
getUpdateMask
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated. If provided, only the existing product
fields are updated. Missing products will not be created.
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided imported products
to update. If
not set, all fields are updated. If provided, only the existing product
fields are updated. Missing products will not be created.
$this
getReconciliationMode
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL .
int
setReconciliationMode
The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL .
var
int
$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 both cloud-retail-customer-data-access@system.gserviceaccount.com
and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com
have the pubsub.topics.publish
IAM permission on the topic.
Only supported when ImportProductsRequest.reconciliation_mode
is set to FULL
.
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 both cloud-retail-customer-data-access@system.gserviceaccount.com
and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com
have the pubsub.topics.publish
IAM permission on the topic.
Only supported when ImportProductsRequest.reconciliation_mode
is set to FULL
.
var
string
$this
