Reference documentation and code samples for the Google Cloud Retail V2 Client class ListControlsRequest.
Request for ListControls method.
Generated from protobuf message google.cloud.retail.v2.ListControlsRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
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 previous ListControls
call. 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 if filter is 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}
string
setParent
Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
var
string
$this
getPageSize
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
int
setPageSize
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
var
int
$this
getPageToken
Optional. A page token, received from a previous ListControls
call.
Provide this to retrieve the subsequent page.
string
setPageToken
Optional. A page token, received from a previous ListControls
call.
Provide this to retrieve the subsequent page.
var
string
$this
getFilter
Optional. A filter to apply on the list results. Supported features:
-
List all the products under the parent branch if filter is unset.
-
List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
string
setFilter
Optional. A filter to apply on the list results. Supported features:
-
List all the products under the parent branch if filter is unset.
-
List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'
var
string
$this
static::build
parent
string
Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Please see Google\Cloud\Retail\V2\ControlServiceClient::catalogName()
for help formatting this field.
