Class InsertLocalInventoryRequest.Builder (1.19.0) 

public static final class InsertLocalInventoryRequest.Builder extends GeneratedMessage.Builder<InsertLocalInventoryRequest.Builder> implements InsertLocalInventoryRequestOrBuilder

Request message for the InsertLocalInventory method.

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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > InsertLocalInventoryRequest.Builder

Static Methods

getDescriptor()

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

Methods

build()

public InsertLocalInventoryRequest build()
Returns
Type Description
InsertLocalInventoryRequest

buildPartial()

public InsertLocalInventoryRequest buildPartial()
Returns
Type Description
InsertLocalInventoryRequest

clear()

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

clearLocalInventory()

public InsertLocalInventoryRequest.Builder clearLocalInventory()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
InsertLocalInventoryRequest.Builder

clearParent()

public InsertLocalInventoryRequest.Builder clearParent()

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
InsertLocalInventoryRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public InsertLocalInventoryRequest getDefaultInstanceForType()
Returns
Type Description
InsertLocalInventoryRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getLocalInventory()

public LocalInventory getLocalInventory()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LocalInventory

The localInventory.

getLocalInventoryBuilder()

public LocalInventory.Builder getLocalInventoryBuilder()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LocalInventory.Builder

getLocalInventoryOrBuilder()

public LocalInventoryOrBuilder getLocalInventoryOrBuilder()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
LocalInventoryOrBuilder

getParent()

public String getParent()

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

hasLocalInventory()

public boolean hasLocalInventory()

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the localInventory field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeFrom(InsertLocalInventoryRequest other)

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

mergeLocalInventory(LocalInventory value)

public InsertLocalInventoryRequest.Builder mergeLocalInventory(LocalInventory value)

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value LocalInventory
Returns
Type Description
InsertLocalInventoryRequest.Builder

setLocalInventory(LocalInventory value)

public InsertLocalInventoryRequest.Builder setLocalInventory(LocalInventory value)

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value LocalInventory
Returns
Type Description
InsertLocalInventoryRequest.Builder

setLocalInventory(LocalInventory.Builder builderForValue)

public InsertLocalInventoryRequest.Builder setLocalInventory(LocalInventory.Builder builderForValue)

Required. Local inventory information of the product. If the product already has a LocalInventory resource for the same storeCode, full replacement of the LocalInventory resource is performed.

.google.shopping.merchant.inventories.v1.LocalInventory local_inventory = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue LocalInventory.Builder
Returns
Type Description
InsertLocalInventoryRequest.Builder

setParent(String value)

public InsertLocalInventoryRequest.Builder setParent(String value)

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
InsertLocalInventoryRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public InsertLocalInventoryRequest.Builder setParentBytes(ByteString value)

Required. The account and product where this inventory will be inserted. Format: accounts/{account}/products/{product}

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, the {product} segment must be the unpadded base64url encoding of this string, which is ZW5-VVN-c2t1LzEyMw. The full resource name for the product would be accounts/123/products/ZW5-VVN-c2t1LzEyMw.

  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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
InsertLocalInventoryRequest.Builder

This builder for chaining.