Reference documentation and code samples for the Google Cloud Retail V2 Client class ListControlsRequest.
Request for ListControls method.
Generated from protobuf messagegoogle.cloud.retail.v2.ListControlsRequest
Namespace
Google \ Cloud \ Retail \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The catalog resource name. Format:projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
↳ page_size
int
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
↳ page_token
string
Optional. A page token, received from a previousListControlscall. Provide this to retrieve the subsequent page.
↳ filter
string
Optional. A filter to apply on the list results. Supported features: * * List all the products under the parent branch iffilteris unset. * * List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
getParent
Required. The catalog resource name. Format:projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Returns
Type
Description
string
setParent
Required. The catalog resource name. Format:projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Optional. Maximum number of results to return. If unspecified, defaults
to 50. Max allowed value is 1000.
Returns
Type
Description
int
setPageSize
Optional. Maximum number of results to return. If unspecified, defaults
to 50. Max allowed value is 1000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A page token, received from a previousListControlscall.
Provide this to retrieve the subsequent page.
Returns
Type
Description
string
setPageToken
Optional. A page token, received from a previousListControlscall.
Provide this to retrieve the subsequent page.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getFilter
Optional. A filter to apply on the list results. Supported features:
List all the products under the parent branch iffilteris unset.
List controls that are used in a single ServingConfig:
'serving_config = "boosted_home_page_cvr"'
Returns
Type
Description
string
setFilter
Optional. A filter to apply on the list results. Supported features:
List all the products under the parent branch iffilteris unset.
List controls that are used in a single ServingConfig:
'serving_config = "boosted_home_page_cvr"'
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The catalog resource name. Format:projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}Please seeControlServiceClient::catalogName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Retail V2 Client - Class ListControlsRequest (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.ListControlsRequest)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.ListControlsRequest)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.ListControlsRequest)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.ListControlsRequest)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.ListControlsRequest)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.ListControlsRequest)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.ListControlsRequest)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.ListControlsRequest)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.ListControlsRequest)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.ListControlsRequest)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.ListControlsRequest)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.ListControlsRequest)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.ListControlsRequest) \nReference documentation and code samples for the Google Cloud Retail V2 Client class ListControlsRequest.\n\nRequest for ListControls method.\n\nGenerated from protobuf message `google.cloud.retail.v2.ListControlsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The catalog resource name. Format:\n`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`\n\n### setParent\n\nRequired. The catalog resource name. Format:\n`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`\n\n### getPageSize\n\nOptional. Maximum number of results to return. If unspecified, defaults\nto 50. Max allowed value is 1000.\n\n### setPageSize\n\nOptional. Maximum number of results to return. If unspecified, defaults\nto 50. Max allowed value is 1000.\n\n### getPageToken\n\nOptional. A page token, received from a previous `ListControls` call.\n\nProvide this to retrieve the subsequent page.\n\n### setPageToken\n\nOptional. A page token, received from a previous `ListControls` call.\n\nProvide this to retrieve the subsequent page.\n\n### getFilter\n\nOptional. A filter to apply on the list results. Supported features:\n\n- List all the products under the parent branch if\n [filter](/php/docs/reference/cloud-retail/latest/V2.ListControlsRequest#_Google_Cloud_Retail_V2_ListControlsRequest__getFilter__) is unset.\n\n- List controls that are used in a single ServingConfig:\n 'serving_config = \"boosted_home_page_cvr\"'\n\n### setFilter\n\nOptional. A filter to apply on the list results. Supported features:\n\n- List all the products under the parent branch if\n [filter](/php/docs/reference/cloud-retail/latest/V2.ListControlsRequest#_Google_Cloud_Retail_V2_ListControlsRequest__getFilter__) is unset.\n\n- List controls that are used in a single ServingConfig:\n 'serving_config = \"boosted_home_page_cvr\"'\n\n### static::build"]]
