Retail v2 API - Class AddLocalInventoriesRequest (2.11.0) 

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

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

Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.

Inheritance

object > AddLocalInventoriesRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

AddLocalInventoriesRequest()

public AddLocalInventoriesRequest()

AddLocalInventoriesRequest(AddLocalInventoriesRequest)

public AddLocalInventoriesRequest(AddLocalInventoriesRequest other)
Parameter
Name Description
other AddLocalInventoriesRequest

Properties

AddMask

public FieldMask AddMask { get; set; }

Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

Property Value
Type Description
FieldMask

AddTime

public Timestamp AddTime { get; set; }

The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

Property Value
Type Description
Timestamp

AllowMissing

public bool AllowMissing { get; set; }

If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, the local inventory will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2.Product] is created. If set to false, a NOT_FOUND error is returned if the [Product][google.cloud.retail.v2.Product] is not found.

Property Value
Type Description
bool

LocalInventories

public RepeatedField<LocalInventory> LocalInventories { get; }

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

Property Value
Type Description
RepeatedFieldLocalInventory

Product

public string Product { get; set; }

Required. Full resource name of [Product][google.cloud.retail.v2.Product], such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

If the caller does not have permission to access the [Product][google.cloud.retail.v2.Product], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Property Value
Type Description
string

ProductAsProductName

public ProductName ProductAsProductName { get; set; }

ProductName-typed view over the Product resource name property.

Property Value
Type Description
ProductName