- 1.47.0 (latest)
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.1
- 1.31.0
- 1.30.0
- 1.26.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.1
- 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 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
Methods
__construct
Constructor.
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
↳ 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.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
string
setName
Output only. The resource name of the Index.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
string
$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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
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.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
var
string
$this
getDescription
The description of the Index.
Generated from protobuf field string description = 3;
string
setDescription
The description of the Index.
Generated from protobuf field string description = 3;
var
string
$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.
Generated from protobuf field string metadata_schema_uri = 4 [(.google.api.field_behavior) = IMMUTABLE];
string
setMetadataSchemaUri
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.
Generated from protobuf field string metadata_schema_uri = 4 [(.google.api.field_behavior) = IMMUTABLE];
var
string
$this
getMetadata
An additional information about the Index; the schema of the metadata can be found in metadata_schema .
Generated from protobuf field .google.protobuf.Value metadata = 6;
Google\Protobuf\Value|null
hasMetadata
clearMetadata
setMetadata
An additional information about the Index; the schema of the metadata can be found in metadata_schema .
Generated from protobuf field .google.protobuf.Value metadata = 6;
var
Google\Protobuf\Value
$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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
Generated from protobuf field repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
string
setEtag
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
Generated from protobuf field string etag = 8;
var
string
$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.
Generated from protobuf field map<string, string> labels = 9;
Google\Protobuf\Internal\MapField
setLabels
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.
Generated from protobuf field map<string, string> labels = 9;
var
array|Google\Protobuf\Internal\MapField
$this
getCreateTime
Output only. Timestamp when this Index was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when this Index was created.
Generated from protobuf field .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$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] [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.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Google\Protobuf\Timestamp|null
hasUpdateTime
clearUpdateTime
setUpdateTime
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.
Generated from protobuf field .google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
var
Google\Protobuf\Timestamp
$this
getIndexStats
Output only. Stats of the index resource.
Generated from protobuf field .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasIndexStats
clearIndexStats
setIndexStats
Output only. Stats of the index resource.
Generated from protobuf field .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
$this
getIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
Generated from protobuf field .google.cloud.aiplatform.v1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];
int
setIndexUpdateMethod
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
Generated from protobuf field .google.cloud.aiplatform.v1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];
var
int
$this
