public final class Index extends GeneratedMessageV3 implements IndexOrBuilder
A representation of a collection of database items organized in a way that
allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
Protobuf type google.cloud.aiplatform.v1.Index
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DEPLOYED_INDEXES_FIELD_NUMBER
Field Value
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ETAG_FIELD_NUMBER
Field Value
public static final int INDEX_STATS_FIELD_NUMBER
Field Value
public static final int INDEX_UPDATE_METHOD_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
public static final int METADATA_SCHEMA_URI_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static Index getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static Index.Builder newBuilder()
Returns
public static Index.Builder newBuilder(Index prototype)
Parameter
| Name | Description |
| prototype | Index
|
Returns
public static Index parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Index parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
public static Index parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static Index parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Index parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Index parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Index parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static Index parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<Index> parser()
Returns
Methods
public boolean containsLabels(String key)
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.
map<string, string> labels = 9;
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Timestamp when this Index was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this Index was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Index getDefaultInstanceForType()
Returns
public DeployedIndexRef getDeployedIndexes(int index)
Output only. The pointers to DeployedIndexes created from this Index.
An Index can be only deleted if all its DeployedIndexes had been undeployed
first.
repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getDeployedIndexesCount()
Output only. The pointers to DeployedIndexes created from this Index.
An Index can be only deleted if all its DeployedIndexes had been undeployed
first.
repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<DeployedIndexRef> getDeployedIndexesList()
Output only. The pointers to DeployedIndexes created from this Index.
An Index can be only deleted if all its DeployedIndexes had been undeployed
first.
repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public DeployedIndexRefOrBuilder getDeployedIndexesOrBuilder(int index)
Output only. The pointers to DeployedIndexes created from this Index.
An Index can be only deleted if all its DeployedIndexes had been undeployed
first.
repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<? extends DeployedIndexRefOrBuilder> getDeployedIndexesOrBuilderList()
Output only. The pointers to DeployedIndexes created from this Index.
An Index can be only deleted if all its DeployedIndexes had been undeployed
first.
repeated .google.cloud.aiplatform.v1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| List<? extends com.google.cloud.aiplatform.v1.DeployedIndexRefOrBuilder> | |
public String getDescription()
The description of the Index.
string description = 3;
| Type | Description |
| String | The description.
|
public ByteString getDescriptionBytes()
The description of the Index.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
public String 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.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. The display name of the Index.
The name can be up to 128 characters long and can consist of any UTF-8
characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| ByteString | The bytes for displayName.
|
Used to perform consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 8;
| Type | Description |
| String | The etag.
|
public ByteString getEtagBytes()
Used to perform consistent read-modify-write updates. If not set, a blind
"overwrite" update happens.
string etag = 8;
public IndexStats getIndexStats()
Output only. Stats of the index resource.
.google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
public IndexStatsOrBuilder getIndexStatsOrBuilder()
Output only. Stats of the index resource.
.google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Index.IndexUpdateMethod getIndexUpdateMethod()
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be
used by default.
.google.cloud.aiplatform.v1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];
public int getIndexUpdateMethodValue()
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be
used by default.
.google.cloud.aiplatform.v1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| int | The enum numeric value on the wire for indexUpdateMethod.
|
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
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.
map<string, string> labels = 9;
public Map<String,String> getLabelsMap()
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.
map<string, string> labels = 9;
public String getLabelsOrDefault(String key, String defaultValue)
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.
map<string, string> labels = 9;
public String getLabelsOrThrow(String key)
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.
map<string, string> labels = 9;
public Value getMetadata()
An additional information about the Index; the schema of the metadata can
be found in metadata_schema.
.google.protobuf.Value metadata = 6;
| Type | Description |
| Value | The metadata.
|
public ValueOrBuilder getMetadataOrBuilder()
An additional information about the Index; the schema of the metadata can
be found in metadata_schema.
.google.protobuf.Value metadata = 6;
public String 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.
string metadata_schema_uri = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| String | The metadataSchemaUri.
|
public ByteString getMetadataSchemaUriBytes()
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.
string metadata_schema_uri = 4 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
| ByteString | The bytes for metadataSchemaUri.
|
Output only. The resource name of the Index.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| String | The name.
|
public ByteString getNameBytes()
Output only. The resource name of the Index.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Parser<Index> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp 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.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public TimestampOrBuilder getUpdateTimeOrBuilder()
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.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp when this Index was created.
.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the createTime field is set.
|
public boolean hasIndexStats()
Output only. Stats of the index resource.
.google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the indexStats field is set.
|
public boolean hasMetadata()
An additional information about the Index; the schema of the metadata can
be found in metadata_schema.
.google.protobuf.Value metadata = 6;
| Type | Description |
| boolean | Whether the metadata field is set.
|
public boolean hasUpdateTime()
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.
.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public Index.Builder newBuilderForType()
Returns
protected Index.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public Index.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
