Class RemoveLocalInventoriesRequest.Builder (2.55.0) 

public static final class RemoveLocalInventoriesRequest.Builder extends GeneratedMessageV3.Builder<RemoveLocalInventoriesRequest.Builder> implements RemoveLocalInventoriesRequestOrBuilder

Request message for ProductService.RemoveLocalInventories method.

Protobuf type google.cloud.retail.v2beta.RemoveLocalInventoriesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > RemoveLocalInventoriesRequest.Builder

Static Methods

getDescriptor()

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

Methods

addAllPlaceIds(Iterable<String> values)

public RemoveLocalInventoriesRequest.Builder addAllPlaceIds(Iterable<String> values)

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
values Iterable<String>

The placeIds to add.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

addPlaceIds(String value)

public RemoveLocalInventoriesRequest.Builder addPlaceIds(String value)

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
value String

The placeIds to add.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

addPlaceIdsBytes(ByteString value)

public RemoveLocalInventoriesRequest.Builder addPlaceIdsBytes(ByteString value)

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

The bytes of the placeIds to add.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RemoveLocalInventoriesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

build()

public RemoveLocalInventoriesRequest build()
Returns
Type Description
RemoveLocalInventoriesRequest

buildPartial()

public RemoveLocalInventoriesRequest buildPartial()
Returns
Type Description
RemoveLocalInventoriesRequest

clear()

public RemoveLocalInventoriesRequest.Builder clear()
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

clearAllowMissing()

public RemoveLocalInventoriesRequest.Builder clearAllowMissing()

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
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public RemoveLocalInventoriesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public RemoveLocalInventoriesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

clearPlaceIds()

public RemoveLocalInventoriesRequest.Builder clearPlaceIds()

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
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

clearProduct()

public RemoveLocalInventoriesRequest.Builder clearProduct()

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
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

clearRemoveTime()

public RemoveLocalInventoriesRequest.Builder clearRemoveTime()

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
RemoveLocalInventoriesRequest.Builder

clone()

public RemoveLocalInventoriesRequest.Builder clone()
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

getRemoveTimeBuilder()

public Timestamp.Builder getRemoveTimeBuilder()

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
Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RemoveLocalInventoriesRequest other)

public RemoveLocalInventoriesRequest.Builder mergeFrom(RemoveLocalInventoriesRequest other)
Parameter
Name Description
other RemoveLocalInventoriesRequest
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RemoveLocalInventoriesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RemoveLocalInventoriesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

mergeRemoveTime(Timestamp value)

public RemoveLocalInventoriesRequest.Builder mergeRemoveTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RemoveLocalInventoriesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

setAllowMissing(boolean value)

public RemoveLocalInventoriesRequest.Builder setAllowMissing(boolean value)

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;

Parameter
Name Description
value boolean

The allowMissing to set.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public RemoveLocalInventoriesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

setPlaceIds(int index, String value)

public RemoveLocalInventoriesRequest.Builder setPlaceIds(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The placeIds to set.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

setProduct(String value)

public RemoveLocalInventoriesRequest.Builder setProduct(String value)

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) = { ... }

Parameter
Name Description
value String

The product to set.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

setProductBytes(ByteString value)

public RemoveLocalInventoriesRequest.Builder setProductBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for product to set.
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

This builder for chaining.

setRemoveTime(Timestamp value)

public RemoveLocalInventoriesRequest.Builder setRemoveTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

setRemoveTime(Timestamp.Builder builderForValue)

public RemoveLocalInventoriesRequest.Builder setRemoveTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RemoveLocalInventoriesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RemoveLocalInventoriesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final RemoveLocalInventoriesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RemoveLocalInventoriesRequest.Builder
Overrides