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

Version 1.3.0

• 1.13.1 (latest)
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.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
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

The standard list page token.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getReadMask

Mask specifying which fields to read.

Returns
Type	Description
Google\Protobuf\FieldMask|null

hasReadMask

clearReadMask

setReadMask

Mask specifying which fields to read.

Parameter
Name	Description
var	Google\Protobuf\FieldMask

Returns
Type	Description
$this

static::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 Google\Cloud\AIPlatform\V1\IndexServiceClient::locationName() for help formatting this field.

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