public static final class SetInventoryRequest.Builder extends GeneratedMessageV3.Builder<SetInventoryRequest.Builder> implements SetInventoryRequestOrBuilder
Request message for [SetInventory][] method.
Protobuf type google.cloud.retail.v2.SetInventoryRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SetInventoryRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public SetInventoryRequest build()
Returns
buildPartial()
public SetInventoryRequest buildPartial()
Returns
clear()
public SetInventoryRequest.Builder clear()
Returns
Overrides
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;
clearField(Descriptors.FieldDescriptor field)
public SetInventoryRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
clearOneof(Descriptors.OneofDescriptor oneof)
public SetInventoryRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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;
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;
clone()
public SetInventoryRequest.Builder clone()
Returns
Overrides
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;
| Type | Description |
| boolean | The allowMissing.
|
getDefaultInstanceForType()
public SetInventoryRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
| 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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
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;
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;
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;
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;
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;
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;
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
| 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;
| 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;
| Type | Description |
| boolean | Whether the setTime field is set.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(SetInventoryRequest other)
public SetInventoryRequest.Builder mergeFrom(SetInventoryRequest other)
Parameter
Returns
public SetInventoryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public SetInventoryRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
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;
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;
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SetInventoryRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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;
| Name | Description |
| value | boolean
The allowMissing to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public SetInventoryRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
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, [UpdateProduct][] should be invoked instead.
.google.cloud.retail.v2.Product inventory = 1 [(.google.api.field_behavior) = REQUIRED];
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SetInventoryRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
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;
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;
| Name | Description |
| builderForValue | Builder
|
Returns
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;
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;
| Name | Description |
| builderForValue | Builder
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final SetInventoryRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
