public final class AddLocalInventoriesRequest extends GeneratedMessageV3 implements AddLocalInventoriesRequestOrBuilder
Request message for
ProductService.AddLocalInventories
method.
Protobuf type google.cloud.retail.v2.AddLocalInventoriesRequest
Static Fields
ADD_MASK_FIELD_NUMBER
public static final int ADD_MASK_FIELD_NUMBER
Field Value
ADD_TIME_FIELD_NUMBER
public static final int ADD_TIME_FIELD_NUMBER
Field Value
ALLOW_MISSING_FIELD_NUMBER
public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
LOCAL_INVENTORIES_FIELD_NUMBER
public static final int LOCAL_INVENTORIES_FIELD_NUMBER
Field Value
PRODUCT_FIELD_NUMBER
public static final int PRODUCT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AddLocalInventoriesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AddLocalInventoriesRequest.Builder newBuilder()
Returns
newBuilder(AddLocalInventoriesRequest prototype)
public static AddLocalInventoriesRequest.Builder newBuilder(AddLocalInventoriesRequest prototype)
Parameter
Returns
public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AddLocalInventoriesRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AddLocalInventoriesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AddLocalInventoriesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AddLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AddLocalInventoriesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AddLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AddLocalInventoriesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AddLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AddLocalInventoriesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
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;
| Type | Description |
| boolean | The allowMissing.
|
getDefaultInstanceForType()
public AddLocalInventoriesRequest getDefaultInstanceForType()
Returns
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];
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];
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];
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];
| Type | Description |
| List<? extends com.google.cloud.retail.v2.LocalInventoryOrBuilder> | |
getParserForType()
public Parser<AddLocalInventoriesRequest> getParserForType()
Returns
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) = { ... }
| 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) = { ... }
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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;
| 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;
| Type | Description |
| boolean | Whether the addTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AddLocalInventoriesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AddLocalInventoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AddLocalInventoriesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
