Google Cloud Ai Platform V1 Client - Class ListIndexesRequest (0.16.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

Methods

build

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

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\ListIndexesRequest`

__construct

Constructor.

Parameters
Name	Description
`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
Type	Description
`string`

setParent

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

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFilter

The standard list filter.

Returns
Type	Description
`string`

setFilter

The standard list filter.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPageSize

The standard list page size.

Returns
Type	Description
`int`

setPageSize

The standard list page size.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

The standard list page token.

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

Returns
Type	Description
`string`

setPageToken