Class RemoveLocalInventoriesRequest (2.49.0)

public final class RemoveLocalInventoriesRequest extends GeneratedMessageV3 implements RemoveLocalInventoriesRequestOrBuilder

Request message for ProductService.RemoveLocalInventories method.

Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesRequest

Static Fields

ALLOW_MISSING_FIELD_NUMBER

public static final int ALLOW_MISSING_FIELD_NUMBER
Field Value
Type Description
int

PLACE_IDS_FIELD_NUMBER

public static final int PLACE_IDS_FIELD_NUMBER
Field Value
Type Description
int

PRODUCT_FIELD_NUMBER

public static final int PRODUCT_FIELD_NUMBER
Field Value
Type Description
int

REMOVE_TIME_FIELD_NUMBER

public static final int REMOVE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RemoveLocalInventoriesRequest getDefaultInstance()
Returns
Type Description
RemoveLocalInventoriesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RemoveLocalInventoriesRequest.Builder newBuilder()
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

newBuilder(RemoveLocalInventoriesRequest prototype)

public static RemoveLocalInventoriesRequest.Builder newBuilder(RemoveLocalInventoriesRequest prototype)
Parameter
Name Description
prototype RemoveLocalInventoriesRequest
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

parseDelimitedFrom(InputStream input)

public static RemoveLocalInventoriesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RemoveLocalInventoriesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RemoveLocalInventoriesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RemoveLocalInventoriesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RemoveLocalInventoriesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RemoveLocalInventoriesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RemoveLocalInventoriesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RemoveLocalInventoriesRequest> parser()
Returns
Type Description
Parser<RemoveLocalInventoriesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
boolean

The allowMissing.

getDefaultInstanceForType()

public RemoveLocalInventoriesRequest getDefaultInstanceForType()
Returns
Type Description
RemoveLocalInventoriesRequest

getParserForType()

public Parser<RemoveLocalInventoriesRequest> getParserForType()
Returns
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
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.

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
Type Description
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
Type Description
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the removeTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RemoveLocalInventoriesRequest.Builder newBuilderForType()
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RemoveLocalInventoriesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RemoveLocalInventoriesRequest.Builder toBuilder()
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException