Class Index.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
com.google.cloud.aiplatform.v1.Index.Builder
All Implemented Interfaces:
IndexOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Index

public static final class Index.Builder extends com.google.protobuf.GeneratedMessage.Builder<Index.Builder> 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
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • clear

      public Index.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • getDefaultInstanceForType

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

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

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

      public Index.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.Builder>
    • mergeFrom

      public Index.Builder mergeFrom(Index other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Index.Builder>
    • mergeFrom

      public Index.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Index.Builder>
      Throws:
      IOException
    • 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.
    • setName

      public Index.Builder setName(String value)
       Output only. The resource name of the Index.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public Index.Builder clearName()
       Output only. The resource name of the Index.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • setNameBytes

      public Index.Builder setNameBytes(com.google.protobuf.ByteString value)
       Output only. The resource name of the Index.
       
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDisplayName

      public Index.Builder setDisplayName(String value)
       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];
      Parameters:
      value - The displayName to set.
      Returns:
      This builder for chaining.
    • clearDisplayName

      public Index.Builder clearDisplayName()
       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:
      This builder for chaining.
    • setDisplayNameBytes

      public Index.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for displayName to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDescription

      public Index.Builder setDescription(String value)
       The description of the Index.
       
      string description = 3;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.
    • clearDescription

      public Index.Builder clearDescription()
       The description of the Index.
       
      string description = 3;
      Returns:
      This builder for chaining.
    • setDescriptionBytes

      public Index.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
       The description of the Index.
       
      string description = 3;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.
    • 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.
    • setMetadataSchemaUri

      public Index.Builder setMetadataSchemaUri(String value)
       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];
      Parameters:
      value - The metadataSchemaUri to set.
      Returns:
      This builder for chaining.
    • clearMetadataSchemaUri

      public Index.Builder clearMetadataSchemaUri()
       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:
      This builder for chaining.
    • setMetadataSchemaUriBytes

      public Index.Builder setMetadataSchemaUriBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for metadataSchemaUri to set.
      Returns:
      This builder for chaining.
    • 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.
    • setMetadata

      public Index.Builder setMetadata(com.google.protobuf.Value value)
       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;
    • setMetadata

      public Index.Builder setMetadata(com.google.protobuf.Value.Builder builderForValue)
       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;
    • mergeMetadata

      public Index.Builder mergeMetadata(com.google.protobuf.Value value)
       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;
    • clearMetadata

      public Index.Builder clearMetadata()
       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;
    • getMetadataBuilder

      public com.google.protobuf.Value.Builder getMetadataBuilder()
       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;
    • 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
    • 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
    • setDeployedIndexes

      public Index.Builder setDeployedIndexes(int index, DeployedIndexRef value)
       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];
    • setDeployedIndexes

      public Index.Builder setDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)
       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];
    • addDeployedIndexes

      public Index.Builder addDeployedIndexes(DeployedIndexRef value)
       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];
    • addDeployedIndexes

      public Index.Builder addDeployedIndexes(int index, DeployedIndexRef value)
       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];
    • addDeployedIndexes

      public Index.Builder addDeployedIndexes(DeployedIndexRef.Builder builderForValue)
       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];
    • addDeployedIndexes

      public Index.Builder addDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)
       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];
    • addAllDeployedIndexes

      public Index.Builder addAllDeployedIndexes(Iterable<? extends DeployedIndexRef> values)
       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];
    • clearDeployedIndexes

      public Index.Builder clearDeployedIndexes()
       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];
    • removeDeployedIndexes

      public Index.Builder removeDeployedIndexes(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];
    • getDeployedIndexesBuilder

      public DeployedIndexRef.Builder getDeployedIndexesBuilder(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];
    • 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
    • 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
    • addDeployedIndexesBuilder

      public DeployedIndexRef.Builder addDeployedIndexesBuilder()
       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];
    • addDeployedIndexesBuilder

      public DeployedIndexRef.Builder addDeployedIndexesBuilder(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];
    • getDeployedIndexesBuilderList

      public List<DeployedIndexRef.Builder> getDeployedIndexesBuilderList()
       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

      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.
    • setEtag

      public Index.Builder setEtag(String value)
       Used to perform consistent read-modify-write updates. If not set, a blind
       "overwrite" update happens.
       
      string etag = 8;
      Parameters:
      value - The etag to set.
      Returns:
      This builder for chaining.
    • clearEtag

      public Index.Builder clearEtag()
       Used to perform consistent read-modify-write updates. If not set, a blind
       "overwrite" update happens.
       
      string etag = 8;
      Returns:
      This builder for chaining.
    • setEtagBytes

      public Index.Builder setEtagBytes(com.google.protobuf.ByteString value)
       Used to perform consistent read-modify-write updates. If not set, a blind
       "overwrite" update happens.
       
      string etag = 8;
      Parameters:
      value - The bytes for etag to set.
      Returns:
      This builder for chaining.
    • 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
    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels 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
    • clearLabels

      public Index.Builder clearLabels()
    • removeLabels

      public Index.Builder removeLabels(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;
    • getMutableLabels

      @Deprecated public Map<String,String> getMutableLabels()
      Deprecated.
      Use alternate mutation accessors instead.
    • putLabels

      public Index.Builder putLabels(String key, String value)
       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;
    • putAllLabels

      public Index.Builder putAllLabels(Map<String,String> values)
       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

      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.
    • setCreateTime

      public Index.Builder setCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Index was created.
       
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • setCreateTime

      public Index.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       Output only. Timestamp when this Index was created.
       
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • mergeCreateTime

      public Index.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
       Output only. Timestamp when this Index was created.
       
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • clearCreateTime

      public Index.Builder clearCreateTime()
       Output only. Timestamp when this Index was created.
       
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getCreateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
       Output only. Timestamp when this Index was created.
       
      .google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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.
    • setUpdateTime

      public Index.Builder setUpdateTime(com.google.protobuf.Timestamp value)
       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];
    • setUpdateTime

      public Index.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];
    • mergeUpdateTime

      public Index.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
       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];
    • clearUpdateTime

      public Index.Builder clearUpdateTime()
       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];
    • getUpdateTimeBuilder

      public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
       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];
    • 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.
    • setIndexStats

      public Index.Builder setIndexStats(IndexStats value)
       Output only. Stats of the index resource.
       
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • setIndexStats

      public Index.Builder setIndexStats(IndexStats.Builder builderForValue)
       Output only. Stats of the index resource.
       
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • mergeIndexStats

      public Index.Builder mergeIndexStats(IndexStats value)
       Output only. Stats of the index resource.
       
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • clearIndexStats

      public Index.Builder clearIndexStats()
       Output only. Stats of the index resource.
       
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • getIndexStatsBuilder

      public IndexStats.Builder getIndexStatsBuilder()
       Output only. Stats of the index resource.
       
      .google.cloud.aiplatform.v1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
    • 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.
    • setIndexUpdateMethodValue

      public Index.Builder setIndexUpdateMethodValue(int value)
       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];
      Parameters:
      value - The enum numeric value on the wire for indexUpdateMethod to set.
      Returns:
      This builder for chaining.
    • 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.
    • setIndexUpdateMethod

      public Index.Builder setIndexUpdateMethod(Index.IndexUpdateMethod value)
       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];
      Parameters:
      value - The indexUpdateMethod to set.
      Returns:
      This builder for chaining.
    • clearIndexUpdateMethod

      public Index.Builder clearIndexUpdateMethod()
       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:
      This builder for chaining.
    • 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.
    • setEncryptionSpec

      public Index.Builder setEncryptionSpec(EncryptionSpec value)
       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];
    • setEncryptionSpec

      public Index.Builder setEncryptionSpec(EncryptionSpec.Builder builderForValue)
       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];
    • mergeEncryptionSpec

      public Index.Builder mergeEncryptionSpec(EncryptionSpec value)
       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];
    • clearEncryptionSpec

      public Index.Builder clearEncryptionSpec()
       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];
    • getEncryptionSpecBuilder

      public EncryptionSpec.Builder getEncryptionSpecBuilder()
       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];
    • 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
    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface IndexOrBuilder
      Returns:
      The satisfiesPzs.
    • setSatisfiesPzs

      public Index.Builder setSatisfiesPzs(boolean value)
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzs to set.
      Returns:
      This builder for chaining.
    • clearSatisfiesPzs

      public Index.Builder clearSatisfiesPzs()
       Output only. Reserved for future use.
       
      bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.
    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface IndexOrBuilder
      Returns:
      The satisfiesPzi.
    • setSatisfiesPzi

      public Index.Builder setSatisfiesPzi(boolean value)
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The satisfiesPzi to set.
      Returns:
      This builder for chaining.
    • clearSatisfiesPzi

      public Index.Builder clearSatisfiesPzi()
       Output only. Reserved for future use.
       
      bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.