Google Cloud Ai Platform V1 Client - Class Index (0.22.0)

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

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Output only. The resource name of the Index.
`↳ display_name`	`string` Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
`↳ description`	`string` The description of the Index.
`↳ metadata_schema_uri`	`string` Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.
`↳ metadata`	`Google\Protobuf\Value` An additional information about the Index; the schema of the metadata can be found in metadata_schema.
`↳ deployed_indexes`	`array<Google\Cloud\AIPlatform\V1\DeployedIndexRef>` Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
`↳ etag`	`string` Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` The labels with user-defined metadata to organize your Indexes. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this Index was created.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.
`↳ index_stats`	`Google\Cloud\AIPlatform\V1\IndexStats` Output only. Stats of the index resource.
`↳ index_update_method`	`int` Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

getName

Output only. The resource name of the Index.

Returns
Type	Description
`string`

setName

Output only. The resource name of the Index.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDisplayName

Required. The display name of the Index.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns
Type	Description
`string`

setDisplayName

Required. The display name of the Index.

The name can be up to 128 characters long and can consist of any UTF-8 characters.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

The description of the Index.

Returns
Type	Description
`string`

setDescription

The description of the Index.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMetadataSchemaUri

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object.

Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

Returns
Type	Description
`string`

setMetadataSchemaUri

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMetadata

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

Returns
Type	Description
`Google\Protobuf\Value\|null`

hasMetadata

clearMetadata

setMetadata

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

Parameter
Name	Description
`var`	`Google\Protobuf\Value`

Returns
Type	Description
`$this`

getDeployedIndexes

Output only. The pointers to DeployedIndexes created from this Index.

An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setDeployedIndexes

Output only. The pointers to DeployedIndexes created from this Index.

An Index can be only deleted if all its DeployedIndexes had been undeployed first.

Parameter
Name	Description
`var`	`array<Google\Cloud\AIPlatform\V1\DeployedIndexRef>`

Returns
Type	Description
`$this`

getEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns
Type	Description
`string`

setEtag

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

The labels with user-defined metadata to organize your Indexes.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

The labels with user-defined metadata to organize your Indexes.

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getCreateTime

Output only. Timestamp when this Index was created.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp when this Index was created.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Timestamp when this Index was most recently updated.

This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp when this Index was most recently updated.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getIndexStats

Output only. Stats of the index resource.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\IndexStats\|null`

hasIndexStats

clearIndexStats

setIndexStats

Output only. Stats of the index resource.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\IndexStats`

Returns
Type	Description
`$this`

getIndexUpdateMethod

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Returns
Type	Description
`int`

setIndexUpdateMethod

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`