Google Cloud Ai Platform V1 Client - Class ListIndexesRequest (0.31.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class ListIndexesRequest.

Request message for IndexService.ListIndexes.

Generated from protobuf message google.cloud.aiplatform.v1.ListIndexesRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}

↳ filter string

The standard list filter.

↳ page_size int

The standard list page size.

↳ page_token string

The standard list page token. Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.

↳ read_mask Google\Protobuf\FieldMask

Mask specifying which fields to read.

getParent

Required. The resource name of the Location from which to list the Indexes.

Format: projects/{project}/locations/{location}

Returns
TypeDescription
string

setParent

Required. The resource name of the Location from which to list the Indexes.

Format: projects/{project}/locations/{location}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

The standard list filter.

Returns
TypeDescription
string

setFilter

The standard list filter.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

The standard list page size.

Returns
TypeDescription
int

setPageSize

The standard list page size.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPageToken

The standard list page token.

Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.

Returns
TypeDescription
string

setPageToken

The standard list page token.

Typically obtained via ListIndexesResponse.next_page_token of the previous IndexService.ListIndexes call.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadMask

Mask specifying which fields to read.

Returns
TypeDescription
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
NameDescription
var Google\Protobuf\FieldMask
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location} Please see Google\Cloud\AIPlatform\V1\IndexServiceClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AIPlatform\V1\ListIndexesRequest