com.google.cloud.retail.v2

Class AddLocalInventoriesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.AddLocalInventoriesRequest

All Implemented Interfaces:

AddLocalInventoriesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AddLocalInventoriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements AddLocalInventoriesRequestOrBuilder

 Request message for
 [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories]
 method.
 

Protobuf type google.cloud.retail.v2.AddLocalInventoriesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddLocalInventoriesRequest.Builder Request message for [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADD_MASK_FIELD_NUMBER
static int	ADD_TIME_FIELD_NUMBER
static int	ALLOW_MISSING_FIELD_NUMBER
static int	LOCAL_INVENTORIES_FIELD_NUMBER
static int	PRODUCT_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
com.google.protobuf.FieldMask	getAddMask() Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
com.google.protobuf.FieldMaskOrBuilder	getAddMaskOrBuilder() Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
com.google.protobuf.Timestamp	getAddTime() The time when the inventory updates are issued.
com.google.protobuf.TimestampOrBuilder	getAddTimeOrBuilder() The time when the inventory updates are issued.
boolean	getAllowMissing() If set to true, and the [Product][google.cloud.retail.v2.Product] is not found, the local inventory will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2.Product] is created.
static AddLocalInventoriesRequest	getDefaultInstance()
AddLocalInventoriesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
LocalInventory	getLocalInventories(int index) Required.
int	getLocalInventoriesCount() Required.
List<LocalInventory>	getLocalInventoriesList() Required.
LocalInventoryOrBuilder	getLocalInventoriesOrBuilder(int index) Required.
List<? extends LocalInventoryOrBuilder>	getLocalInventoriesOrBuilderList() Required.
com.google.protobuf.Parser<AddLocalInventoriesRequest>	getParserForType()
String	getProduct() Required.
com.google.protobuf.ByteString	getProductBytes() Required.
int	getSerializedSize()
boolean	hasAddMask() Indicates which inventory fields in the provided list of [LocalInventory][google.cloud.retail.v2.LocalInventory] to update.
boolean	hasAddTime() The time when the inventory updates are issued.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AddLocalInventoriesRequest.Builder	newBuilder()
static AddLocalInventoriesRequest.Builder	newBuilder(AddLocalInventoriesRequest prototype)
AddLocalInventoriesRequest.Builder	newBuilderForType()
protected AddLocalInventoriesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AddLocalInventoriesRequest	parseDelimitedFrom(InputStream input)
static AddLocalInventoriesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddLocalInventoriesRequest	parseFrom(byte[] data)
static AddLocalInventoriesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddLocalInventoriesRequest	parseFrom(ByteBuffer data)
static AddLocalInventoriesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddLocalInventoriesRequest	parseFrom(com.google.protobuf.ByteString data)
static AddLocalInventoriesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddLocalInventoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static AddLocalInventoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AddLocalInventoriesRequest	parseFrom(InputStream input)
static AddLocalInventoriesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AddLocalInventoriesRequest>	parser()
AddLocalInventoriesRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER

See Also:

Constant Field Values

LOCAL_INVENTORIES_FIELD_NUMBER

public static final int LOCAL_INVENTORIES_FIELD_NUMBER

See Also:

Constant Field Values

ADD_MASK_FIELD_NUMBER

public static final int ADD_MASK_FIELD_NUMBER

See Also:

Constant Field Values

ADD_TIME_FIELD_NUMBER

public static final int ADD_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProduct

public String getProduct()

 Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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) = { ... }

Specified by:

getProduct in interface AddLocalInventoriesRequestOrBuilder

Returns:

The product.

getProductBytes

public com.google.protobuf.ByteString getProductBytes()

 Required. Full resource name of [Product][google.cloud.retail.v2.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][google.cloud.retail.v2.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) = { ... }

Specified by:

getProductBytes in interface AddLocalInventoriesRequestOrBuilder

Returns:

The bytes for product.

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];

Specified by:

getLocalInventoriesList in interface AddLocalInventoriesRequestOrBuilder

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];

Specified by:

getLocalInventoriesOrBuilderList in interface AddLocalInventoriesRequestOrBuilder

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];

Specified by:

getLocalInventoriesCount in interface AddLocalInventoriesRequestOrBuilder

getLocalInventories

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];

Specified by:

getLocalInventories in interface AddLocalInventoriesRequestOrBuilder

getLocalInventoriesOrBuilder

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];

Specified by:

getLocalInventoriesOrBuilder in interface AddLocalInventoriesRequestOrBuilder

hasAddMask

public boolean hasAddMask()

 Indicates which inventory fields in the provided list of
 [LocalInventory][google.cloud.retail.v2.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;

Specified by:

hasAddMask in interface AddLocalInventoriesRequestOrBuilder

Returns:

Whether the addMask field is set.

getAddMask

public com.google.protobuf.FieldMask getAddMask()

 Indicates which inventory fields in the provided list of
 [LocalInventory][google.cloud.retail.v2.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;

Specified by:

getAddMask in interface AddLocalInventoriesRequestOrBuilder

Returns:

The addMask.

getAddMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getAddMaskOrBuilder()

 Indicates which inventory fields in the provided list of
 [LocalInventory][google.cloud.retail.v2.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;

Specified by:

getAddMaskOrBuilder in interface AddLocalInventoriesRequestOrBuilder

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;

Specified by:

hasAddTime in interface AddLocalInventoriesRequestOrBuilder

Returns:

Whether the addTime field is set.

getAddTime

public com.google.protobuf.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;

Specified by:

getAddTime in interface AddLocalInventoriesRequestOrBuilder

Returns:

The addTime.

getAddTimeOrBuilder

public com.google.protobuf.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;

Specified by:

getAddTimeOrBuilder in interface AddLocalInventoriesRequestOrBuilder

getAllowMissing

public boolean getAllowMissing()

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

bool allow_missing = 6;

Specified by:

getAllowMissing in interface AddLocalInventoriesRequestOrBuilder

Returns:

The allowMissing.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AddLocalInventoriesRequest parseFrom(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AddLocalInventoriesRequest parseFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static AddLocalInventoriesRequest parseFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input)
                                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static AddLocalInventoriesRequest parseDelimitedFrom(InputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException

Throws:

IOException

parseFrom

public static AddLocalInventoriesRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                            throws IOException

Throws:

IOException

parseFrom

public static AddLocalInventoriesRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

newBuilderForType

public AddLocalInventoriesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AddLocalInventoriesRequest.Builder newBuilder()

newBuilder

public static AddLocalInventoriesRequest.Builder newBuilder(AddLocalInventoriesRequest prototype)

toBuilder

public AddLocalInventoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AddLocalInventoriesRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AddLocalInventoriesRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<AddLocalInventoriesRequest> parser()

getParserForType

public com.google.protobuf.Parser<AddLocalInventoriesRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AddLocalInventoriesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder