public final class AddLocalInventoriesRequest extends GeneratedMessageV3 implements AddLocalInventoriesRequestOrBuilder
Request message for
ProductService.AddLocalInventories
method.
Protobuf type google.cloud.retail.v2.AddLocalInventoriesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AddLocalInventoriesRequest.Builder newBuilder()
newBuilder(AddLocalInventoriesRequest prototype)
public static AddLocalInventoriesRequest.Builder newBuilder(AddLocalInventoriesRequest prototype)
public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input)
public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AddLocalInventoriesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AddLocalInventoriesRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(CodedInputStream input)
public static AddLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(InputStream input)
public static AddLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AddLocalInventoriesRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AddLocalInventoriesRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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;
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;
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()
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.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
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.v2.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.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
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.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
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.v2.LocalInventory local_inventories = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2.LocalInventoryOrBuilder> |
|
getParserForType()
public Parser<AddLocalInventoriesRequest> getParserForType()
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AddLocalInventoriesRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AddLocalInventoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AddLocalInventoriesRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
