Interface SetInventoryRequestOrBuilder (2.15.0)

Version 2.15.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.1
• 2.4.0
• 2.3.0
• 2.2.3
• 2.1.0
• 2.0.19

public interface SetInventoryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowMissing()

public abstract boolean getAllowMissing()

If set to true, and the Product with name Product.name is not found, the inventory update will still be processed and retained for at most 1 day until the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 4;

Returns
Type	Description
boolean	The allowMissing.

getInventory()

public abstract Product getInventory()

Required. The inventory information to update. The allowable fields to update are:

• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The caller can replace place IDs for a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types and corresponding place IDs to update in SetInventoryRequest.inventory.fulfillment_info The caller can clear all place IDs from a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types to clear in SetInventoryRequest.inventory.fulfillment_info
• Checks that only the desired fulfillment info types have empty SetInventoryRequest.inventory.fulfillment_info.place_ids The last update time is recorded for the following inventory fields:
• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, ProductService.UpdateProduct should be invoked instead.

.google.cloud.retail.v2beta.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Product	The inventory.

getInventoryOrBuilder()

public abstract ProductOrBuilder getInventoryOrBuilder()

Required. The inventory information to update. The allowable fields to update are:

• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The caller can replace place IDs for a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types and corresponding place IDs to update in SetInventoryRequest.inventory.fulfillment_info The caller can clear all place IDs from a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types to clear in SetInventoryRequest.inventory.fulfillment_info
• Checks that only the desired fulfillment info types have empty SetInventoryRequest.inventory.fulfillment_info.place_ids The last update time is recorded for the following inventory fields:
• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, ProductService.UpdateProduct should be invoked instead.

.google.cloud.retail.v2beta.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ProductOrBuilder

getSetMask()

public abstract FieldMask getSetMask()

Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask set_mask = 2;

Returns
Type	Description
FieldMask	The setMask.

getSetMaskOrBuilder()

public abstract FieldMaskOrBuilder getSetMaskOrBuilder()

Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask set_mask = 2;

Returns
Type	Description
FieldMaskOrBuilder

getSetTime()

public abstract Timestamp getSetTime()

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used.

.google.protobuf.Timestamp set_time = 3;

Returns
Type	Description
Timestamp	The setTime.

getSetTimeOrBuilder()

public abstract TimestampOrBuilder getSetTimeOrBuilder()

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used.

.google.protobuf.Timestamp set_time = 3;

Returns
Type	Description
TimestampOrBuilder

hasInventory()

public abstract boolean hasInventory()

Required. The inventory information to update. The allowable fields to update are:

• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info The updated inventory fields must be specified in SetInventoryRequest.set_mask. If SetInventoryRequest.inventory.name is empty or invalid, an INVALID_ARGUMENT error is returned. If the caller does not have permission to update the Product named in Product.name, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to update does not have existing inventory information, the provided inventory information will be inserted. If the Product to update has existing inventory information, the provided inventory information will be merged while respecting the last update time for each inventory field, using the provided or default value for SetInventoryRequest.set_time. The caller can replace place IDs for a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types and corresponding place IDs to update in SetInventoryRequest.inventory.fulfillment_info The caller can clear all place IDs from a subset of fulfillment types in the following ways:
• Adds "fulfillment_info" in SetInventoryRequest.set_mask
• Specifies only the desired fulfillment types to clear in SetInventoryRequest.inventory.fulfillment_info
• Checks that only the desired fulfillment info types have empty SetInventoryRequest.inventory.fulfillment_info.place_ids The last update time is recorded for the following inventory fields:
• Product.price_info
• Product.availability
• Product.available_quantity
• Product.fulfillment_info If a full overwrite of inventory information while ignoring timestamps is needed, ProductService.UpdateProduct should be invoked instead.

.google.cloud.retail.v2beta.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the inventory field is set.

hasSetMask()

public abstract boolean hasSetMask()

Indicates which inventory fields in the provided Product to update. At least one field must be provided. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask set_mask = 2;

Returns
Type	Description
boolean	Whether the setMask field is set.

hasSetTime()

public abstract boolean hasSetTime()

The time when the request is issued, used to prevent out-of-order updates on inventory fields with the last update time recorded. If not provided, the internal system time will be used.

.google.protobuf.Timestamp set_time = 3;

Returns
Type	Description
boolean	Whether the setTime field is set.