Class SetInventoryRequest (2.44.0)

Version 2.44.0

• 2.54.0 (latest)
• 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 final class SetInventoryRequest extends GeneratedMessageV3 implements SetInventoryRequestOrBuilder

Request message for ProductService.SetInventory method.

Protobuf type google.cloud.retail.v2.SetInventoryRequest

Inheritance

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

Implements

SetInventoryRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER

Field Value
Type	Description
int

INVENTORY_FIELD_NUMBER

public static final int INVENTORY_FIELD_NUMBER

Field Value
Type	Description
int

SET_MASK_FIELD_NUMBER

public static final int SET_MASK_FIELD_NUMBER

Field Value
Type	Description
int

SET_TIME_FIELD_NUMBER

public static final int SET_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SetInventoryRequest getDefaultInstance()

Returns
Type	Description
SetInventoryRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SetInventoryRequest.Builder newBuilder()

Returns
Type	Description
SetInventoryRequest.Builder

newBuilder(SetInventoryRequest prototype)

public static SetInventoryRequest.Builder newBuilder(SetInventoryRequest prototype)

Parameter
Name	Description
prototype	SetInventoryRequest

Returns
Type	Description
SetInventoryRequest.Builder

parseDelimitedFrom(InputStream input)

public static SetInventoryRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SetInventoryRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SetInventoryRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SetInventoryRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SetInventoryRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SetInventoryRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SetInventoryRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SetInventoryRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SetInventoryRequest> parser()

Returns
Type	Description
Parser<SetInventoryRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

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.

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

getParserForType()

public Parser<SetInventoryRequest> getParserForType()

Returns
Type	Description
Parser<SetInventoryRequest>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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.

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SetInventoryRequest.Builder newBuilderForType()

Returns
Type	Description
SetInventoryRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SetInventoryRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SetInventoryRequest.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SetInventoryRequest.Builder toBuilder()

Returns
Type	Description
SetInventoryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException