# Interface ListLocalInventoriesRequestOrBuilder (1.21.0)

1.21.0 (latest) 1.19.0 1.16.0 1.15.0 1.13.0 1.11.0 1.10.0 1.8.0 1.6.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.46.0 0.44.0 0.43.0 0.40.0 0.39.0 0.38.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0

    public interface ListLocalInventoriesRequestOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getPageSize()

    public abstract int getPageSize()

The maximum number of `LocalInventory` 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 25000; If a value higher than
the maximum is specified, then the `pageSize` will default to the maximum

`int32 page_size = 2;`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The pageSize. |

### getPageToken()

    public abstract String getPageToken()

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

When paginating, all other parameters provided to `ListLocalInventories`
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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The pageToken. |

### getPageTokenBytes()

    public abstract ByteString getPageTokenBytes()

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

When paginating, all other parameters provided to `ListLocalInventories`
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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for pageToken. |

### getParent()

    public abstract String getParent()

Required. The `name` of the parent product to list local inventories 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The parent. |

### getParentBytes()

    public abstract ByteString getParentBytes()

Required. The `name` of the parent product to list local inventories 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for parent. |