Class SetInventoryRequest (2.48.0)

public final class SetInventoryRequest extends GeneratedMessageV3 implements SetInventoryRequestOrBuilder

Request message for ProductService.SetInventory method.

Protobuf type google.cloud.retail.v2alpha.SetInventoryRequest

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

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

Returns
Type Description
ProductOrBuilder

getParserForType()

public Parser<SetInventoryRequest> getParserForType()
Returns
Type Description
Parser<SetInventoryRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SetInventoryRequest.Builder toBuilder()
Returns
Type Description
SetInventoryRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException