com.google.cloud.retail.v2

Interface SetInventoryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SetInventoryRequest, SetInventoryRequest.Builder

public interface SetInventoryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAllowMissing() If set to true, and the [Product][google.cloud.retail.v2.Product] with name [Product.name][google.cloud.retail.v2.Product.name] is not found, the inventory update will still be processed and retained for at most 1 day until the [Product][google.cloud.retail.v2.Product] is created.
Product	getInventory() Required.
ProductOrBuilder	getInventoryOrBuilder() Required.
com.google.protobuf.FieldMask	getSetMask() Indicates which inventory fields in the provided [Product][google.cloud.retail.v2.Product] to update.
com.google.protobuf.FieldMaskOrBuilder	getSetMaskOrBuilder() Indicates which inventory fields in the provided [Product][google.cloud.retail.v2.Product] to update.
com.google.protobuf.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.
com.google.protobuf.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.
boolean	hasInventory() Required.
boolean	hasSetMask() Indicates which inventory fields in the provided [Product][google.cloud.retail.v2.Product] to update.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInventory

boolean hasInventory()

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

 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 The updated inventory fields must be specified in
 [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].

 If
 [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
 is empty or invalid, an INVALID_ARGUMENT error is returned.

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

 If the [Product][google.cloud.retail.v2.Product] to update does not have
 existing inventory information, the provided inventory information will be
 inserted.

 If the [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types and corresponding place IDs
 to update in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types to clear in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 * Checks that only the desired fulfillment info types have empty
 [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]

 The last update time is recorded for the following inventory fields:
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

 If a full overwrite of inventory information while ignoring timestamps is
 needed,
 [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
 should be invoked instead.
 

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

Returns:

Whether the inventory field is set.

getInventory

Product getInventory()

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

 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 The updated inventory fields must be specified in
 [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].

 If
 [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
 is empty or invalid, an INVALID_ARGUMENT error is returned.

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

 If the [Product][google.cloud.retail.v2.Product] to update does not have
 existing inventory information, the provided inventory information will be
 inserted.

 If the [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types and corresponding place IDs
 to update in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types to clear in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 * Checks that only the desired fulfillment info types have empty
 [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]

 The last update time is recorded for the following inventory fields:
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

 If a full overwrite of inventory information while ignoring timestamps is
 needed,
 [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
 should be invoked instead.
 

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

Returns:

The inventory.

getInventoryOrBuilder

ProductOrBuilder getInventoryOrBuilder()

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

 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 The updated inventory fields must be specified in
 [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].

 If
 [SetInventoryRequest.inventory.name][google.cloud.retail.v2.Product.name]
 is empty or invalid, an INVALID_ARGUMENT error is returned.

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

 If the [Product][google.cloud.retail.v2.Product] to update does not have
 existing inventory information, the provided inventory information will be
 inserted.

 If the [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types and corresponding place IDs
 to update in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.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][google.cloud.retail.v2.SetInventoryRequest.set_mask]
 * Specifies only the desired fulfillment types to clear in
 [SetInventoryRequest.inventory.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
 * Checks that only the desired fulfillment info types have empty
 [SetInventoryRequest.inventory.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]

 The last update time is recorded for the following inventory fields:
 * [Product.price_info][google.cloud.retail.v2.Product.price_info]
 * [Product.availability][google.cloud.retail.v2.Product.availability]
 * [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
 * [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]

 If a full overwrite of inventory information while ignoring timestamps is
 needed,
 [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
 should be invoked instead.
 

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

hasSetMask

boolean hasSetMask()

 Indicates which inventory fields in the provided
 [Product][google.cloud.retail.v2.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:

Whether the setMask field is set.

getSetMask

com.google.protobuf.FieldMask getSetMask()

 Indicates which inventory fields in the provided
 [Product][google.cloud.retail.v2.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:

The setMask.

getSetMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getSetMaskOrBuilder()

 Indicates which inventory fields in the provided
 [Product][google.cloud.retail.v2.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;

hasSetTime

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:

Whether the setTime field is set.

getSetTime

com.google.protobuf.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:

The setTime.

getSetTimeOrBuilder

com.google.protobuf.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;

getAllowMissing

boolean getAllowMissing()

 If set to true, and the [Product][google.cloud.retail.v2.Product] with name
 [Product.name][google.cloud.retail.v2.Product.name] is not found, the
 inventory update will still be processed and retained for at most 1 day
 until 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.
 

bool allow_missing = 4;

Returns:

The allowMissing.