Class InsertRegionalInventoryRequest.Builder (1.19.0)

public static final class InsertRegionalInventoryRequest.Builder extends GeneratedMessage.Builder<InsertRegionalInventoryRequest.Builder> implements InsertRegionalInventoryRequestOrBuilder

Request message for the InsertRegionalInventory method.

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

Static Methods

getDescriptor()

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

Methods

build()

public InsertRegionalInventoryRequest build()
Returns
Type Description
InsertRegionalInventoryRequest

buildPartial()

public InsertRegionalInventoryRequest buildPartial()
Returns
Type Description
InsertRegionalInventoryRequest

clear()

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

clearParent()

public InsertRegionalInventoryRequest.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
InsertRegionalInventoryRequest.Builder

This builder for chaining.

clearRegionalInventory()

public InsertRegionalInventoryRequest.Builder clearRegionalInventory()

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Returns
Type Description
InsertRegionalInventoryRequest.Builder

getDefaultInstanceForType()

public InsertRegionalInventoryRequest getDefaultInstanceForType()
Returns
Type Description
InsertRegionalInventoryRequest

getDescriptorForType()

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

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.

getRegionalInventory()

public RegionalInventory getRegionalInventory()

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Returns
Type Description
RegionalInventory

The regionalInventory.

getRegionalInventoryBuilder()

public RegionalInventory.Builder getRegionalInventoryBuilder()

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Returns
Type Description
RegionalInventory.Builder

getRegionalInventoryOrBuilder()

public RegionalInventoryOrBuilder getRegionalInventoryOrBuilder()

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Returns
Type Description
RegionalInventoryOrBuilder

hasRegionalInventory()

public boolean hasRegionalInventory()

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Returns
Type Description
boolean

Whether the regionalInventory 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 InsertRegionalInventoryRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
InsertRegionalInventoryRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeFrom(InsertRegionalInventoryRequest other)

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

mergeRegionalInventory(RegionalInventory value)

public InsertRegionalInventoryRequest.Builder mergeRegionalInventory(RegionalInventory value)

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Parameter
Name Description
value RegionalInventory
Returns
Type Description
InsertRegionalInventoryRequest.Builder

setParent(String value)

public InsertRegionalInventoryRequest.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
InsertRegionalInventoryRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public InsertRegionalInventoryRequest.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
InsertRegionalInventoryRequest.Builder

This builder for chaining.

setRegionalInventory(RegionalInventory value)

public InsertRegionalInventoryRequest.Builder setRegionalInventory(RegionalInventory value)

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Parameter
Name Description
value RegionalInventory
Returns
Type Description
InsertRegionalInventoryRequest.Builder

setRegionalInventory(RegionalInventory.Builder builderForValue)

public InsertRegionalInventoryRequest.Builder setRegionalInventory(RegionalInventory.Builder builderForValue)

Required. Regional inventory information to add to the product. If the product already has a RegionalInventory resource for the same region, full replacement of the RegionalInventory resource is performed.

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

Parameter
Name Description
builderForValue RegionalInventory.Builder
Returns
Type Description
InsertRegionalInventoryRequest.Builder