Class SetInventoryRequest.Builder (2.47.0)

Version 2.47.0

• 2.56.0 (latest)
• 2.55.0
• 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 static final class SetInventoryRequest.Builder extends GeneratedMessageV3.Builder<SetInventoryRequest.Builder> implements SetInventoryRequestOrBuilder

Request message for ProductService.SetInventory method.

Protobuf type google.cloud.retail.v2.SetInventoryRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SetInventoryRequest.Builder

Implements

SetInventoryRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SetInventoryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SetInventoryRequest build()

Returns
Type	Description
SetInventoryRequest

buildPartial()

public SetInventoryRequest buildPartial()

Returns
Type	Description
SetInventoryRequest

clear()

public SetInventoryRequest.Builder clear()

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAllowMissing()

public SetInventoryRequest.Builder clearAllowMissing()

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
SetInventoryRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SetInventoryRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInventory()

public SetInventoryRequest.Builder clearInventory()

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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
SetInventoryRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public SetInventoryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSetMask()

public SetInventoryRequest.Builder clearSetMask()

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
SetInventoryRequest.Builder

clearSetTime()

public SetInventoryRequest.Builder clearSetTime()

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
SetInventoryRequest.Builder

clone()

public SetInventoryRequest.Builder clone()

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAllowMissing()

public 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.

getDefaultInstanceForType()

public SetInventoryRequest getDefaultInstanceForType()

Returns
Type	Description
SetInventoryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getInventory()

public 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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Product	The inventory.

getInventoryBuilder()

public Product.Builder getInventoryBuilder()

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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Product.Builder

getInventoryOrBuilder()

public 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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ProductOrBuilder

getSetMask()

public 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.

getSetMaskBuilder()

public FieldMask.Builder getSetMaskBuilder()

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
Builder

getSetMaskOrBuilder()

public 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 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.

getSetTimeBuilder()

public Timestamp.Builder getSetTimeBuilder()

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
Builder

getSetTimeOrBuilder()

public 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 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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the inventory field is set.

hasSetMask()

public 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SetInventoryRequest other)

public SetInventoryRequest.Builder mergeFrom(SetInventoryRequest other)

Parameter
Name	Description
other	SetInventoryRequest

Returns
Type	Description
SetInventoryRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SetInventoryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SetInventoryRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeInventory(Product value)

public SetInventoryRequest.Builder mergeInventory(Product value)

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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Product

Returns
Type	Description
SetInventoryRequest.Builder

mergeSetMask(FieldMask value)

public SetInventoryRequest.Builder mergeSetMask(FieldMask value)

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;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
SetInventoryRequest.Builder

mergeSetTime(Timestamp value)

public SetInventoryRequest.Builder mergeSetTime(Timestamp value)

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;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
SetInventoryRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SetInventoryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAllowMissing(boolean value)

public SetInventoryRequest.Builder setAllowMissing(boolean value)

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;

Parameter
Name	Description
value	boolean The allowMissing to set.

Returns
Type	Description
SetInventoryRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SetInventoryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInventory(Product value)

public SetInventoryRequest.Builder setInventory(Product value)

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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	Product

Returns
Type	Description
SetInventoryRequest.Builder

setInventory(Product.Builder builderForValue)

public SetInventoryRequest.Builder setInventory(Product.Builder builderForValue)

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.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
builderForValue	Product.Builder

Returns
Type	Description
SetInventoryRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SetInventoryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSetMask(FieldMask value)

public SetInventoryRequest.Builder setSetMask(FieldMask value)

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;

Parameter
Name	Description
value	FieldMask

Returns
Type	Description
SetInventoryRequest.Builder

setSetMask(FieldMask.Builder builderForValue)

public SetInventoryRequest.Builder setSetMask(FieldMask.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
SetInventoryRequest.Builder

setSetTime(Timestamp value)

public SetInventoryRequest.Builder setSetTime(Timestamp value)

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;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
SetInventoryRequest.Builder

setSetTime(Timestamp.Builder builderForValue)

public SetInventoryRequest.Builder setSetTime(Timestamp.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
SetInventoryRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SetInventoryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)