Class AddLocalInventoriesRequest (2.46.0)

public final class AddLocalInventoriesRequest extends GeneratedMessageV3 implements AddLocalInventoriesRequestOrBuilder

Request message for ProductService.AddLocalInventories method.

Protobuf type google.cloud.retail.v2alpha.AddLocalInventoriesRequest

Static Fields

ADD_MASK_FIELD_NUMBER

public static final int ADD_MASK_FIELD_NUMBER
Field Value
Type Description
int

ADD_TIME_FIELD_NUMBER

public static final int ADD_TIME_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
Type Description
int

LOCAL_INVENTORIES_FIELD_NUMBER

public static final int LOCAL_INVENTORIES_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AddLocalInventoriesRequest getDefaultInstance()
Returns
Type Description
AddLocalInventoriesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AddLocalInventoriesRequest.Builder newBuilder()
Returns
Type Description
AddLocalInventoriesRequest.Builder

newBuilder(AddLocalInventoriesRequest prototype)

public static AddLocalInventoriesRequest.Builder newBuilder(AddLocalInventoriesRequest prototype)
Parameter
Name Description
prototype AddLocalInventoriesRequest
Returns
Type Description
AddLocalInventoriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AddLocalInventoriesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AddLocalInventoriesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AddLocalInventoriesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AddLocalInventoriesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AddLocalInventoriesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AddLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AddLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AddLocalInventoriesRequest> parser()
Returns
Type Description
Parser<AddLocalInventoriesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddMask()

public FieldMask getAddMask()

Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask add_mask = 4;

Returns
Type Description
FieldMask

The addMask.

getAddMaskOrBuilder()

public FieldMaskOrBuilder getAddMaskOrBuilder()

Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask add_mask = 4;

Returns
Type Description
FieldMaskOrBuilder

getAddTime()

public Timestamp getAddTime()

The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

.google.protobuf.Timestamp add_time = 5;

Returns
Type Description
Timestamp

The addTime.

getAddTimeOrBuilder()

public TimestampOrBuilder getAddTimeOrBuilder()

The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

.google.protobuf.Timestamp add_time = 5;

Returns
Type Description
TimestampOrBuilder

getAllowMissing()

public boolean getAllowMissing()

If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 6;

Returns
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public AddLocalInventoriesRequest getDefaultInstanceForType()
Returns
Type Description
AddLocalInventoriesRequest

getLocalInventories(int index)

public LocalInventory getLocalInventories(int index)

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
LocalInventory

getLocalInventoriesCount()

public int getLocalInventoriesCount()

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getLocalInventoriesList()

public List<LocalInventory> getLocalInventoriesList()

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<LocalInventory>

getLocalInventoriesOrBuilder(int index)

public LocalInventoryOrBuilder getLocalInventoriesOrBuilder(int index)

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
LocalInventoryOrBuilder

getLocalInventoriesOrBuilderList()

public List<? extends LocalInventoryOrBuilder> getLocalInventoriesOrBuilderList()

Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.

repeated .google.cloud.retail.v2alpha.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.retail.v2alpha.LocalInventoryOrBuilder>

getParserForType()

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

getProduct()

public String getProduct()

Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The product.

getProductBytes()

public ByteString getProductBytes()

Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id.

If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

string product = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for product.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasAddMask()

public boolean hasAddMask()

Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value.

If a field is set while the place does not have a previous local inventory, the local inventory at that store is created.

If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted.

If the mask is not set or set with empty paths, all inventory fields will be updated.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.

.google.protobuf.FieldMask add_mask = 4;

Returns
Type Description
boolean

Whether the addMask field is set.

hasAddTime()

public boolean hasAddTime()

The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.

.google.protobuf.Timestamp add_time = 5;

Returns
Type Description
boolean

Whether the addTime 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 AddLocalInventoriesRequest.Builder newBuilderForType()
Returns
Type Description
AddLocalInventoriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AddLocalInventoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AddLocalInventoriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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