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
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The catalog resource name. Format: |
↳ 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 |
↳ 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}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The catalog resource name. Format:
projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| 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.
Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
Generated from protobuf field int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| 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.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. A page token, received from a previous ListControls call.
Provide this to retrieve the subsequent page.
Generated from protobuf field string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| 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"'
Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| 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"'
Generated from protobuf field string filter = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |