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

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

Request message for DataStoreService.ListDataStores method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
↳ page_size int

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
↳ page_token string

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
↳ filter string

Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

getParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Returns
Type Description
string

setParent

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50.

Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.

Returns
Type Description
int

setPageSize

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50.

Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type Description
string

setPageToken

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Filter by solution type .

For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

Returns
Type Description
string

setFilter

Filter by solution type .

For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. Please see Google\Cloud\DiscoveryEngine\V1\DataStoreServiceClient::collectionName() for help formatting this field.
Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\ListDataStoresRequest