Class ImportProductsRequest (1.20.0)

Version latest

• 1.20.1 (latest)
• 1.20.0
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

ImportProductsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Request message for Import methods.

Attributes
Name	Description
parent	str 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	str Deprecated. This field has no effect.
input_config	google.cloud.retail_v2alpha.types.ProductInputConfig Required. The desired input location of the data.
errors_config	google.cloud.retail_v2alpha.types.ImportErrorsConfig The desired location of errors incurred during the Import.
update_mask	google.protobuf.field_mask_pb2.FieldMask Indicates which fields in the provided imported products to update. If not set, all fields are updated.
reconciliation_mode	google.cloud.retail_v2alpha.types.ImportProductsRequest.ReconciliationMode The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
notification_pubsub_topic	str 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][google.longrunning.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- has the pubsub.topics.publish IAM permission on the topic.
skip_default_branch_protection	bool If true, this performs the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

Classes

ReconciliationMode

ReconciliationMode(value)

Indicates how imported products are reconciled with the existing products created or imported before.

Values: RECONCILIATION_MODE_UNSPECIFIED (0): Defaults to INCREMENTAL. INCREMENTAL (1): Inserts new products or updates existing products. FULL (2): Calculates diff and replaces the entire product dataset. Existing products may be deleted if they are not present in the source location.