# Google Cloud Retail V2 Client - Class ListCatalogsRequest (2.5.3)

2.5.3 (latest) 2.5.2 2.4.0 2.3.1 2.2.1 2.1.3 2.0.0 1.7.0 1.6.4 1.5.0 1.4.2 1.3.1 1.2.1 1.1.1 1.0.1 Reference documentation and code samples for the Google Cloud Retail V2 Client class ListCatalogsRequest.

Request for
[CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__)
method.

Generated from protobuf message `google.cloud.retail.v2.ListCatalogsRequest`

## Namespace

Google \\ Cloud \\ Retail \\ V2

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ parent` | `string` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. |
| `↳ page_size` | `int` Maximum number of [Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned. |
| `↳ page_token` | `string` A page token [ListCatalogsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.ListCatalogsResponse#_Google_Cloud_Retail_V2_ListCatalogsResponse__getNextPageToken__), received from a previous [CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__) call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to [CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__) must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. |

### getParent

Required. The account resource name with an associated location.

If the caller does not have permission to list
[Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setParent

Required. The account resource name with an associated location.

If the caller does not have permission to list
[Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s under this location, regardless
of whether or not this location exists, a PERMISSION_DENIED error is
returned.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageSize

Maximum number of [Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s to return. If
unspecified, defaults to 50. The maximum allowed value is 1000. Values
above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` |   |

### setPageSize

Maximum number of [Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s to return. If
unspecified, defaults to 50. The maximum allowed value is 1000. Values
above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT is returned.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getPageToken

A page token
[ListCatalogsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.ListCatalogsResponse#_Google_Cloud_Retail_V2_ListCatalogsResponse__getNextPageToken__),
received from a previous
[CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__)
call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to
[CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__)
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setPageToken

A page token
[ListCatalogsResponse.next_page_token](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.ListCatalogsResponse#_Google_Cloud_Retail_V2_ListCatalogsResponse__getNextPageToken__),
received from a previous
[CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__)
call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to
[CatalogService.ListCatalogs](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Client.CatalogServiceClient#_Google_Cloud_Retail_V2_Client_CatalogServiceClient__listCatalogs__)
must match the call that provided the page token. Otherwise, an
INVALID_ARGUMENT error is returned.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `parent` | `string` Required. The account resource name with an associated location. If the caller does not have permission to list [Catalog](https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.Catalog)s under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned. Please see CatalogServiceClient::locationName() for help formatting this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-retail/latest/V2.ListCatalogsRequest` |   |