Class RemoveLocalInventoriesRequest (2.33.0)

public final class RemoveLocalInventoriesRequest extends GeneratedMessageV3 implements RemoveLocalInventoriesRequestOrBuilder

Request message for ProductService.RemoveLocalInventories method.

Protobuf type google.cloud.retail.v2.RemoveLocalInventoriesRequest

Static Fields

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
TypeDescription
int

PLACE_IDS_FIELD_NUMBER

public static final int PLACE_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
TypeDescription
int

REMOVE_TIME_FIELD_NUMBER

public static final int REMOVE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RemoveLocalInventoriesRequest getDefaultInstance()
Returns
TypeDescription
RemoveLocalInventoriesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static RemoveLocalInventoriesRequest.Builder newBuilder()
Returns
TypeDescription
RemoveLocalInventoriesRequest.Builder

newBuilder(RemoveLocalInventoriesRequest prototype)

public static RemoveLocalInventoriesRequest.Builder newBuilder(RemoveLocalInventoriesRequest prototype)
Parameter
NameDescription
prototypeRemoveLocalInventoriesRequest
Returns
TypeDescription
RemoveLocalInventoriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static RemoveLocalInventoriesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static RemoveLocalInventoriesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RemoveLocalInventoriesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RemoveLocalInventoriesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static RemoveLocalInventoriesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static RemoveLocalInventoriesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RemoveLocalInventoriesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<RemoveLocalInventoriesRequest> parser()
Returns
TypeDescription
Parser<RemoveLocalInventoriesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllowMissing()

public boolean getAllowMissing()

If set to true, and the 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 is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

bool allow_missing = 3;

Returns
TypeDescription
boolean

The allowMissing.

getDefaultInstanceForType()

public RemoveLocalInventoriesRequest getDefaultInstanceForType()
Returns
TypeDescription
RemoveLocalInventoriesRequest

getParserForType()

public Parser<RemoveLocalInventoriesRequest> getParserForType()
Returns
TypeDescription
Parser<RemoveLocalInventoriesRequest>
Overrides

getPlaceIds(int index)

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The placeIds at the given index.

getPlaceIdsBytes(int index)

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the placeIds at the given index.

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

Returns
TypeDescription
int

The count of placeIds.

getPlaceIdsList()

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

Returns
TypeDescription
ProtocolStringList

A list containing the placeIds.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for product.

getRemoveTime()

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

Returns
TypeDescription
Timestamp

The removeTime.

getRemoveTimeOrBuilder()

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

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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;

Returns
TypeDescription
boolean

Whether the removeTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public RemoveLocalInventoriesRequest.Builder newBuilderForType()
Returns
TypeDescription
RemoveLocalInventoriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RemoveLocalInventoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RemoveLocalInventoriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public RemoveLocalInventoriesRequest.Builder toBuilder()
Returns
TypeDescription
RemoveLocalInventoriesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException