Discovery Engine v1 API - Class ListDataStoresRequest (1.3.0)

public sealed class ListDataStoresRequest : IMessage<ListDataStoresRequest>, IEquatable<ListDataStoresRequest>, IDeepCloneable<ListDataStoresRequest>, IBufferMessage, IMessage, IPageRequest

Reference documentation and code samples for the Discovery Engine v1 API class ListDataStoresRequest.

Request message for [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] method.

Inheritance

object > ListDataStoresRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

ListDataStoresRequest()

public ListDataStoresRequest()

ListDataStoresRequest(ListDataStoresRequest)

public ListDataStoresRequest(ListDataStoresRequest other)
Parameter
Name Description
other ListDataStoresRequest

Properties

Filter

public string Filter { get; set; }

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

Property Value
Type Description
string

PageSize

public int PageSize { get; set; }

Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s 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.

Property Value
Type Description
int

PageToken

public string PageToken { get; set; }

A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call. Provide this to retrieve the subsequent page.

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

Property Value
Type Description
string

Parent

public string Parent { get; set; }

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

If the caller does not have permission to list [DataStore][google.cloud.discoveryengine.v1.DataStore]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Property Value
Type Description
string

ParentAsCollectionName

public CollectionName ParentAsCollectionName { get; set; }

CollectionName-typed view over the Parent resource name property.

Property Value
Type Description
CollectionName