Google Cloud Retail V2 Client - Class ListControlsRequest (1.7.0)

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 \ 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 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}

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 previous ListControls call.

Provide this to retrieve the subsequent page.

Returns
Type Description
string

setPageToken

Optional. A page token, received from a previous ListControls call.

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 if filter is 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 if filter is 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 see Google\Cloud\Retail\V2\ControlServiceClient::catalogName() for help formatting this field.
Returns
Type Description
Google\Cloud\Retail\V2\ListControlsRequest