Retail v2 API - Class ImportProductsRequest (2.11.0)

public sealed class ImportProductsRequest : IMessage<ImportProductsRequest>, IEquatable<ImportProductsRequest>, IDeepCloneable<ImportProductsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class ImportProductsRequest.

Request message for Import methods.

Inheritance

object > ImportProductsRequest

Implements

IMessage ImportProductsRequest, IEquatable ImportProductsRequest, IDeepCloneable ImportProductsRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ImportProductsRequest()

public ImportProductsRequest()

ImportProductsRequest(ImportProductsRequest)

public ImportProductsRequest(ImportProductsRequest other)

Parameter
Name	Description
`other`	`ImportProductsRequest`

Properties

ErrorsConfig

public ImportErrorsConfig ErrorsConfig { get; set; }

The desired location of errors incurred during the Import.

Property Value
Type	Description
`ImportErrorsConfig`

InputConfig

public ProductInputConfig InputConfig { get; set; }

Required. The desired input location of the data.

Property Value
Type	Description
`ProductInputConfig`

NotificationPubsubTopic

public string NotificationPubsubTopic { get; set; }

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][google.cloud.retail.v2.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][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode] is set to FULL.

Property Value
Type	Description
`string`

Parent

public string Parent { get; set; }

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.

Property Value
Type	Description
`string`

ParentAsBranchName

public BranchName ParentAsBranchName { get; set; }

BranchName-typed view over the Parent resource name property.

Property Value
Type	Description
`BranchName`

ReconciliationMode

public ImportProductsRequest.Types.ReconciliationMode ReconciliationMode { get; set; }

The mode of reconciliation between existing products and the products to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL].

Property Value
Type	Description
`ImportProductsRequestTypesReconciliationMode`

RequestId

[Obsolete]
public string RequestId { get; set; }

Deprecated. This field has no effect.

Property Value
Type	Description
`string`

UpdateMask

public FieldMask UpdateMask { get; set; }

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.

Property Value
Type	Description
`FieldMask`