Class ListRegionalInventoriesRequest.Builder (1.19.0) 

public static final class ListRegionalInventoriesRequest.Builder extends GeneratedMessage.Builder<ListRegionalInventoriesRequest.Builder> implements ListRegionalInventoriesRequestOrBuilder

Request message for the ListRegionalInventories method.

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

Inheritance

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

Static Methods

getDescriptor()

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

Methods

build()

public ListRegionalInventoriesRequest build()
Returns
Type Description
ListRegionalInventoriesRequest

buildPartial()

public ListRegionalInventoriesRequest buildPartial()
Returns
Type Description
ListRegionalInventoriesRequest

clear()

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

clearPageSize()

public ListRegionalInventoriesRequest.Builder clearPageSize()

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

int32 page_size = 2;

Returns
Type Description
ListRegionalInventoriesRequest.Builder

This builder for chaining.

clearPageToken()

public ListRegionalInventoriesRequest.Builder clearPageToken()

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

string page_token = 3;

Returns
Type Description
ListRegionalInventoriesRequest.Builder

This builder for chaining.

clearParent()

public ListRegionalInventoriesRequest.Builder clearParent()

Required. The name of the parent product to list RegionalInventory resources for. 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
ListRegionalInventoriesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListRegionalInventoriesRequest getDefaultInstanceForType()
Returns
Type Description
ListRegionalInventoriesRequest

getDescriptorForType()

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

getPageSize()

public int getPageSize()

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of the parent product to list RegionalInventory resources for. 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 name of the parent product to list RegionalInventory resources for. 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.

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

mergeFrom(Message other)

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

mergeFrom(ListRegionalInventoriesRequest other)

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

setPageSize(int value)

public ListRegionalInventoriesRequest.Builder setPageSize(int value)

The maximum number of RegionalInventory resources for the given product to return. The service returns fewer than this value if the number of inventories for the given product is less that than the pageSize. The default value is 25000. The maximum value is 100000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.
Returns
Type Description
ListRegionalInventoriesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListRegionalInventoriesRequest.Builder setPageToken(String value)

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.
Returns
Type Description
ListRegionalInventoriesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListRegionalInventoriesRequest.Builder setPageTokenBytes(ByteString value)

A page token, received from a previous ListRegionalInventories call. Provide the page token to retrieve the subsequent page.

When paginating, all other parameters provided to ListRegionalInventories must match the call that provided the page token. The token returned as nextPageToken in the response to the previous request.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.
Returns
Type Description
ListRegionalInventoriesRequest.Builder

This builder for chaining.

setParent(String value)

public ListRegionalInventoriesRequest.Builder setParent(String value)

Required. The name of the parent product to list RegionalInventory resources for. 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
ListRegionalInventoriesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListRegionalInventoriesRequest.Builder setParentBytes(ByteString value)

Required. The name of the parent product to list RegionalInventory resources for. 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
ListRegionalInventoriesRequest.Builder

This builder for chaining.