Class DeleteLocalInventoryRequest (1.19.0)

public final class DeleteLocalInventoryRequest extends GeneratedMessage implements DeleteLocalInventoryRequestOrBuilder

Request message for the DeleteLocalInventory method.

Protobuf type google.shopping.merchant.inventories.v1.DeleteLocalInventoryRequest

Static Fields

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DeleteLocalInventoryRequest getDefaultInstance()
Returns
Type Description
DeleteLocalInventoryRequest

getDescriptor()

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

newBuilder()

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

newBuilder(DeleteLocalInventoryRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DeleteLocalInventoryRequest getDefaultInstanceForType()
Returns
Type Description
DeleteLocalInventoryRequest

getName()

public String getName()

Required. The name of the local inventory for the given product to delete. Format: accounts/{account}/products/{product}/localInventories/{store_code}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123

The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

  1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.
  2. Example: To represent the product ID en~US~sku/123 for store_code "store123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the local inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123.

  3. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~.

    We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the local inventory for the given product to delete. Format: accounts/{account}/products/{product}/localInventories/{store_code}

The {product} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: content_language~feed_label~offer_id. Example: en~US~sku123 For legacy local products, the structure is: local~content_language~feed_label~offer_id. Example: local~en~US~sku123

The format of the {product} segment in the URL is automatically detected by the server, supporting two options:

  1. Encoded Format: The {product} segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the content_language~feed_label~offer_id structure. This encoding MUST be used if any part of the product identifier (like offer_id) contains characters such as /, %, or ~.
  2. Example: To represent the product ID en~US~sku/123 for store_code "store123", the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the local inventory would be accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123.

  3. Plain Format: The {product} segment is the tilde-separated string content_language~feed_label~offer_id. This format is suitable only when content_language, feed_label, and offer_id do not contain URL-problematic characters like /, %, or ~.

    We recommend using the Encoded Format for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (~) characters in the {product} segment is used to differentiate between the two formats.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DeleteLocalInventoryRequest> getParserForType()
Returns
Type Description
Parser<DeleteLocalInventoryRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected DeleteLocalInventoryRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DeleteLocalInventoryRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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