public sealed class ImportProductsRequest : IMessage<ImportProductsRequest>, IEquatable<ImportProductsRequest>, IDeepCloneable<ImportProductsRequest>, IBufferMessage, IMessageRequest message for Import methods.
Implements
IMessage<ImportProductsRequest>, IEquatable<ImportProductsRequest>, IDeepCloneable<ImportProductsRequest>, IBufferMessage, IMessageNamespace
Google.Cloud.Retail.V2Assembly
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; }Pub/Sub topic for receiving notification. If this field is set,
when the import is finished, a notification will be sent to
specified Pub/Sub topic. The message data will be JSON string of a
[Operation][google.longrunning.Operation].
Format of the Pub/Sub topic is projects/{project}/topics/{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 |
ImportProductsRequest.Types.ReconciliationMode |
|
RequestId
public string RequestId { get; set; }Unique identifier provided by client, within the ancestor dataset scope. Ensures idempotency and used for request deduplication. Server-generated if unspecified. Up to 128 characters long and must match the pattern: "[a-zA-Z0-9_]+". This is returned as [Operation.name][] in [ImportMetadata][google.cloud.retail.v2.ImportMetadata].
Only supported when
[ImportProductsRequest.reconciliation_mode][google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode]
is set to FULL.
| Property Value | |
|---|---|
| Type | Description |
String |
|
UpdateMask
public FieldMask UpdateMask { get; set; }Indicates which fields in the provided imported 'products' to update. If not set, will by default update all fields.
| Property Value | |
|---|---|
| Type | Description |
FieldMask |
|