Google Cloud Discovery Engine V1 Client - Class ListControlsRequest (0.11.3)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListControlsRequest.

Request for ListControls method.

Generated from protobuf message google.cloud.discoveryengine.v1.ListControlsRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_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. Currently this field is unsupported.

getParent

Required. The data store resource name. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id} or projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}.

Returns
Type	Description
`string`

setParent

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. Currently this field is unsupported.

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. Currently this field is unsupported.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`. Please see Google\Cloud\DiscoveryEngine\V1\ControlServiceClient::dataStoreName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\DiscoveryEngine\V1\ListControlsRequest`