Package com.google.cloud.aiplatform.v1

Interface IndexOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Index, Index.Builder
@Generated public interface IndexOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

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

    • getNameBytes

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

    • getDisplayName

      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];
      Returns:
      The displayName.

    • getDisplayNameBytes

      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];
      Returns:
      The bytes for displayName.

    • getDescription

      String getDescription()
       The description of the Index.
      string description = 3;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       The description of the Index.
      string description = 3;
      Returns:
      The bytes for description.

    • getMetadataSchemaUri

      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];
      Returns:
      The metadataSchemaUri.

    • getMetadataSchemaUriBytes

      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];
      Returns:
      The bytes for metadataSchemaUri.

    • hasMetadata

      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;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      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;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      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;

    • getDeployedIndexesList

      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];

    • getDeployedIndexes

      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];

    • getDeployedIndexesCount

      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];

    • getDeployedIndexesOrBuilderList

      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];

    • getDeployedIndexesOrBuilder

      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];

    • getEtag

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

    • getEtagBytes

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

    • getLabelsCount

      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;

    • containsLabels

      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;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      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;

    • getLabelsOrDefault

      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;

    • getLabelsOrThrow

      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;

    • hasCreateTime

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

    • getCreateTime

      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];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      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];

    • hasUpdateTime

      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];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      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];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      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];

    • hasIndexStats

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

    • getIndexStats

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

    • getIndexStatsOrBuilder

      IndexStatsOrBuilder getIndexStatsOrBuilder()
       Output only. Stats of the index resource.
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getIndexUpdateMethodValue

      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];
      Returns:
      The enum numeric value on the wire for indexUpdateMethod.

    • getIndexUpdateMethod

      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];
      Returns:
      The indexUpdateMethod.

    • hasEncryptionSpec

      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];
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      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];
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      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];

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The satisfiesPzi.