com.google.cloud.retail.v2alpha

Class RemoveLocalInventoriesRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2alpha.RemoveLocalInventoriesRequest

All Implemented Interfaces:

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

public final class RemoveLocalInventoriesRequest
extends com.google.protobuf.GeneratedMessageV3
implements RemoveLocalInventoriesRequestOrBuilder

 Request message for
 [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories]
 method.
 

Protobuf type google.cloud.retail.v2alpha.RemoveLocalInventoriesRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RemoveLocalInventoriesRequest.Builder Request message for [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] 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	ALLOW_MISSING_FIELD_NUMBER
static int	PLACE_IDS_FIELD_NUMBER
static int	PRODUCT_FIELD_NUMBER
static int	REMOVE_TIME_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)
boolean	getAllowMissing() If set to true, and the [Product][google.cloud.retail.v2alpha.Product] is not found, the local inventory removal request will still be processed and retained for at most 1 day and processed once the [Product][google.cloud.retail.v2alpha.Product] is created.
static RemoveLocalInventoriesRequest	getDefaultInstance()
RemoveLocalInventoriesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RemoveLocalInventoriesRequest>	getParserForType()
String	getPlaceIds(int index) Required.
com.google.protobuf.ByteString	getPlaceIdsBytes(int index) Required.
int	getPlaceIdsCount() Required.
com.google.protobuf.ProtocolStringList	getPlaceIdsList() Required.
String	getProduct() Required.
com.google.protobuf.ByteString	getProductBytes() Required.
com.google.protobuf.Timestamp	getRemoveTime() The time when the inventory deletions are issued.
com.google.protobuf.TimestampOrBuilder	getRemoveTimeOrBuilder() The time when the inventory deletions are issued.
int	getSerializedSize()
int	hashCode()
boolean	hasRemoveTime() The time when the inventory deletions are issued.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RemoveLocalInventoriesRequest.Builder	newBuilder()
static RemoveLocalInventoriesRequest.Builder	newBuilder(RemoveLocalInventoriesRequest prototype)
RemoveLocalInventoriesRequest.Builder	newBuilderForType()
protected RemoveLocalInventoriesRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static RemoveLocalInventoriesRequest	parseDelimitedFrom(InputStream input)
static RemoveLocalInventoriesRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RemoveLocalInventoriesRequest	parseFrom(byte[] data)
static RemoveLocalInventoriesRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RemoveLocalInventoriesRequest	parseFrom(ByteBuffer data)
static RemoveLocalInventoriesRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RemoveLocalInventoriesRequest	parseFrom(com.google.protobuf.ByteString data)
static RemoveLocalInventoriesRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RemoveLocalInventoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static RemoveLocalInventoriesRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RemoveLocalInventoriesRequest	parseFrom(InputStream input)
static RemoveLocalInventoriesRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RemoveLocalInventoriesRequest>	parser()
RemoveLocalInventoriesRequest.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

PLACE_IDS_FIELD_NUMBER

public static final int PLACE_IDS_FIELD_NUMBER

See Also:

Constant Field Values

REMOVE_TIME_FIELD_NUMBER

public static final int REMOVE_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.v2alpha.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.v2alpha.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 RemoveLocalInventoriesRequestOrBuilder

Returns:

The product.

getProductBytes

public com.google.protobuf.ByteString getProductBytes()

 Required. Full resource name of
 [Product][google.cloud.retail.v2alpha.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.v2alpha.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 RemoveLocalInventoriesRequestOrBuilder

Returns:

The bytes for product.

getPlaceIdsList

public com.google.protobuf.ProtocolStringList getPlaceIdsList()

 Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
 

repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlaceIdsList in interface RemoveLocalInventoriesRequestOrBuilder

Returns:

A list containing the placeIds.

getPlaceIdsCount

public int getPlaceIdsCount()

 Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
 

repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlaceIdsCount in interface RemoveLocalInventoriesRequestOrBuilder

Returns:

The count of placeIds.

getPlaceIds

public String getPlaceIds(int index)

 Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
 

repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlaceIds in interface RemoveLocalInventoriesRequestOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The placeIds at the given index.

getPlaceIdsBytes

public com.google.protobuf.ByteString getPlaceIdsBytes(int index)

 Required. A list of place IDs to have their inventory deleted.
 At most 3000 place IDs are allowed per request.
 

repeated string place_ids = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlaceIdsBytes in interface RemoveLocalInventoriesRequestOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the placeIds at the given index.

hasRemoveTime

public boolean hasRemoveTime()

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

.google.protobuf.Timestamp remove_time = 5;

Specified by:

hasRemoveTime in interface RemoveLocalInventoriesRequestOrBuilder

Returns:

Whether the removeTime field is set.

getRemoveTime

public com.google.protobuf.Timestamp getRemoveTime()

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

.google.protobuf.Timestamp remove_time = 5;

Specified by:

getRemoveTime in interface RemoveLocalInventoriesRequestOrBuilder

Returns:

The removeTime.

getRemoveTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getRemoveTimeOrBuilder()

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

.google.protobuf.Timestamp remove_time = 5;

Specified by:

getRemoveTimeOrBuilder in interface RemoveLocalInventoriesRequestOrBuilder

getAllowMissing

public boolean getAllowMissing()

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

bool allow_missing = 3;

Specified by:

getAllowMissing in interface RemoveLocalInventoriesRequestOrBuilder

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 RemoveLocalInventoriesRequest parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RemoveLocalInventoriesRequest parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RemoveLocalInventoriesRequest parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RemoveLocalInventoriesRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RemoveLocalInventoriesRequest.Builder newBuilder()

newBuilder

public static RemoveLocalInventoriesRequest.Builder newBuilder(RemoveLocalInventoriesRequest prototype)

toBuilder

public RemoveLocalInventoriesRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RemoveLocalInventoriesRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RemoveLocalInventoriesRequest> 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 RemoveLocalInventoriesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder