public final class SetInventoryRequest extends com.google.protobuf.GeneratedMessageV3 implements SetInventoryRequestOrBuilder
Request message for [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory] method.Protobuf type
google.cloud.retail.v2.SetInventoryRequest| Modifier and Type | Class and Description |
|---|---|
static class |
SetInventoryRequest.Builder
Request message for
[ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory]
method.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ALLOW_MISSING_FIELD_NUMBER |
static int |
INVENTORY_FIELD_NUMBER |
static int |
SET_MASK_FIELD_NUMBER |
static int |
SET_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.
|
static SetInventoryRequest |
getDefaultInstance() |
SetInventoryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Product |
getInventory()
Required.
|
ProductOrBuilder |
getInventoryOrBuilder()
Required.
|
com.google.protobuf.Parser<SetInventoryRequest> |
getParserForType() |
int |
getSerializedSize() |
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.
|
int |
hashCode() |
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static SetInventoryRequest.Builder |
newBuilder() |
static SetInventoryRequest.Builder |
newBuilder(SetInventoryRequest prototype) |
SetInventoryRequest.Builder |
newBuilderForType() |
protected SetInventoryRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static SetInventoryRequest |
parseDelimitedFrom(InputStream input) |
static SetInventoryRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SetInventoryRequest |
parseFrom(byte[] data) |
static SetInventoryRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SetInventoryRequest |
parseFrom(ByteBuffer data) |
static SetInventoryRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SetInventoryRequest |
parseFrom(com.google.protobuf.ByteString data) |
static SetInventoryRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SetInventoryRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static SetInventoryRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static SetInventoryRequest |
parseFrom(InputStream input) |
static SetInventoryRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<SetInventoryRequest> |
parser() |
SetInventoryRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INVENTORY_FIELD_NUMBER
public static final int SET_MASK_FIELD_NUMBER
public static final int SET_TIME_FIELD_NUMBER
public static final int ALLOW_MISSING_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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];
hasInventory in interface SetInventoryRequestOrBuilderpublic 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];
getInventory in interface SetInventoryRequestOrBuilderpublic 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];
getInventoryOrBuilder in interface SetInventoryRequestOrBuilderpublic 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;hasSetMask in interface SetInventoryRequestOrBuilderpublic 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;getSetMask in interface SetInventoryRequestOrBuilderpublic 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;getSetMaskOrBuilder in interface SetInventoryRequestOrBuilderpublic 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;hasSetTime in interface SetInventoryRequestOrBuilderpublic 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;getSetTime in interface SetInventoryRequestOrBuilderpublic 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;getSetTimeOrBuilder in interface SetInventoryRequestOrBuilderpublic 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;getAllowMissing in interface SetInventoryRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SetInventoryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SetInventoryRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static SetInventoryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SetInventoryRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SetInventoryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SetInventoryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SetInventoryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SetInventoryRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SetInventoryRequest.Builder newBuilder()
public static SetInventoryRequest.Builder newBuilder(SetInventoryRequest prototype)
public SetInventoryRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SetInventoryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static SetInventoryRequest getDefaultInstance()
public static com.google.protobuf.Parser<SetInventoryRequest> parser()
public com.google.protobuf.Parser<SetInventoryRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public SetInventoryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.