Package com.google.cloud.aiplatform.v1

Class Index

  • All Implemented Interfaces:
    IndexOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Index
extends com.google.protobuf.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
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        public String getName()
         Output only. The resource name of the Index.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface IndexOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. The resource name of the Index.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface IndexOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        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];
        Specified by:
        getDisplayName in interface IndexOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.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];
        Specified by:
        getDisplayNameBytes in interface IndexOrBuilder
        Returns:
        The bytes for displayName.

      • getDescription

        public String getDescription()
         The description of the Index.
        string description = 3;
        Specified by:
        getDescription in interface IndexOrBuilder
        Returns:
        The description.

      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         The description of the Index.
        string description = 3;
        Specified by:
        getDescriptionBytes in interface IndexOrBuilder
        Returns:
        The bytes for description.

      • getMetadataSchemaUri

        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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];
        Specified by:
        getMetadataSchemaUri in interface IndexOrBuilder
        Returns:
        The metadataSchemaUri.

      • getMetadataSchemaUriBytes

        public com.google.protobuf.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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 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];
        Specified by:
        getMetadataSchemaUriBytes in interface IndexOrBuilder
        Returns:
        The bytes for metadataSchemaUri.

      • hasMetadata

        public boolean hasMetadata()
         An additional information about the Index; the schema of the metadata can
 be found in
 [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
        .google.protobuf.Value metadata = 6;
        Specified by:
        hasMetadata in interface IndexOrBuilder
        Returns:
        Whether the metadata field is set.

      • getMetadata

        public com.google.protobuf.Value getMetadata()
         An additional information about the Index; the schema of the metadata can
 be found in
 [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
        .google.protobuf.Value metadata = 6;
        Specified by:
        getMetadata in interface IndexOrBuilder
        Returns:
        The metadata.

      • getMetadataOrBuilder

        public com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()
         An additional information about the Index; the schema of the metadata can
 be found in
 [metadata_schema][google.cloud.aiplatform.v1.Index.metadata_schema_uri].
        .google.protobuf.Value metadata = 6;
        Specified by:
        getMetadataOrBuilder in interface IndexOrBuilder

      • getDeployedIndexesList

        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];
        Specified by:
        getDeployedIndexesList in interface IndexOrBuilder

      • getDeployedIndexesOrBuilderList

        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];
        Specified by:
        getDeployedIndexesOrBuilderList in interface IndexOrBuilder

      • getDeployedIndexesCount

        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];
        Specified by:
        getDeployedIndexesCount in interface IndexOrBuilder

      • getDeployedIndexes

        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];
        Specified by:
        getDeployedIndexes in interface IndexOrBuilder

      • getDeployedIndexesOrBuilder

        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];
        Specified by:
        getDeployedIndexesOrBuilder in interface IndexOrBuilder

      • getEtag

        public String getEtag()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 8;
        Specified by:
        getEtag in interface IndexOrBuilder
        Returns:
        The etag.

      • getEtagBytes

        public com.google.protobuf.ByteString getEtagBytes()
         Used to perform consistent read-modify-write updates. If not set, a blind
 "overwrite" update happens.
        string etag = 8;
        Specified by:
        getEtagBytes in interface IndexOrBuilder
        Returns:
        The bytes for etag.

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: IndexOrBuilder
         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;
        Specified by:
        getLabelsCount in interface IndexOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface IndexOrBuilder

      • getLabelsMap

        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;
        Specified by:
        getLabelsMap in interface IndexOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface IndexOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface IndexOrBuilder

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Timestamp when this Index was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface IndexOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         Output only. Timestamp when this Index was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTime in interface IndexOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. Timestamp when this Index was created.
        .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreateTimeOrBuilder in interface IndexOrBuilder

      • hasUpdateTime

        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];
        Specified by:
        hasUpdateTime in interface IndexOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.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];
        Specified by:
        getUpdateTime in interface IndexOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getUpdateTimeOrBuilder in interface IndexOrBuilder

      • hasIndexStats

        public boolean hasIndexStats()
         Output only. Stats of the index resource.
        .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasIndexStats in interface IndexOrBuilder
        Returns:
        Whether the indexStats field is set.

      • getIndexStats

        public IndexStats getIndexStats()
         Output only. Stats of the index resource.
        .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexStats in interface IndexOrBuilder
        Returns:
        The indexStats.

      • getIndexStatsOrBuilder

        public IndexStatsOrBuilder getIndexStatsOrBuilder()
         Output only. Stats of the index resource.
        .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getIndexStatsOrBuilder in interface IndexOrBuilder

      • getIndexUpdateMethodValue

        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];
        Specified by:
        getIndexUpdateMethodValue in interface IndexOrBuilder
        Returns:
        The enum numeric value on the wire for indexUpdateMethod.

      • getIndexUpdateMethod

        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];
        Specified by:
        getIndexUpdateMethod in interface IndexOrBuilder
        Returns:
        The indexUpdateMethod.

      • hasEncryptionSpec

        public boolean hasEncryptionSpec()
         Immutable. Customer-managed encryption key spec for an Index. If set, this
 Index and all sub-resources of this Index will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        hasEncryptionSpec in interface IndexOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        public EncryptionSpec getEncryptionSpec()
         Immutable. Customer-managed encryption key spec for an Index. If set, this
 Index and all sub-resources of this Index will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getEncryptionSpec in interface IndexOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
         Immutable. Customer-managed encryption key spec for an Index. If set, this
 Index and all sub-resources of this Index will be secured by this key.
        .google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getEncryptionSpecOrBuilder in interface IndexOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Index parseFrom​(ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(ByteBuffer data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(com.google.protobuf.ByteString data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(com.google.protobuf.ByteString data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(byte[] data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(byte[] data,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Index parseFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Index.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Index.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Index.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Index getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Index> parser()

      • getParserForType

        public com.google.protobuf.Parser<Index> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Index getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder