Index.Builder (proto-google-cloud-aiplatform-v1 3.63.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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 Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Index.Builder`	`addAllDeployedIndexes(Iterable<? extends DeployedIndexRef> values)` Output only.
`Index.Builder`	`addDeployedIndexes(DeployedIndexRef.Builder builderForValue)` Output only.
`Index.Builder`	`addDeployedIndexes(DeployedIndexRef value)` Output only.
`Index.Builder`	`addDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)` Output only.
`Index.Builder`	`addDeployedIndexes(int index, DeployedIndexRef value)` Output only.
`DeployedIndexRef.Builder`	`addDeployedIndexesBuilder()` Output only.
`DeployedIndexRef.Builder`	`addDeployedIndexesBuilder(int index)` Output only.
`Index.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Index`	`build()`
`Index`	`buildPartial()`
`Index.Builder`	`clear()`
`Index.Builder`	`clearCreateTime()` Output only.
`Index.Builder`	`clearDeployedIndexes()` Output only.
`Index.Builder`	`clearDescription()` The description of the Index.
`Index.Builder`	`clearDisplayName()` Required.
`Index.Builder`	`clearEncryptionSpec()` Immutable.
`Index.Builder`	`clearEtag()` Used to perform consistent read-modify-write updates.
`Index.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Index.Builder`	`clearIndexStats()` Output only.
`Index.Builder`	`clearIndexUpdateMethod()` Immutable.
`Index.Builder`	`clearLabels()`
`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].
`Index.Builder`	`clearMetadataSchemaUri()` Immutable.
`Index.Builder`	`clearName()` Output only.
`Index.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Index.Builder`	`clearSatisfiesPzi()` Output only.
`Index.Builder`	`clearSatisfiesPzs()` Output only.
`Index.Builder`	`clearUpdateTime()` Output only.
`Index.Builder`	`clone()`
`boolean`	`containsLabels(String key)` The labels with user-defined metadata to organize your Indexes.
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.Timestamp.Builder`	`getCreateTimeBuilder()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`Index`	`getDefaultInstanceForType()`
`DeployedIndexRef`	`getDeployedIndexes(int index)` Output only.
`DeployedIndexRef.Builder`	`getDeployedIndexesBuilder(int index)` Output only.
`List<DeployedIndexRef.Builder>`	`getDeployedIndexesBuilderList()` Output only.
`int`	`getDeployedIndexesCount()` Output only.
`List<DeployedIndexRef>`	`getDeployedIndexesList()` Output only.
`DeployedIndexRefOrBuilder`	`getDeployedIndexesOrBuilder(int index)` Output only.
`List<? extends DeployedIndexRefOrBuilder>`	`getDeployedIndexesOrBuilderList()` Output only.
`String`	`getDescription()` The description of the Index.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` The description of the Index.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`EncryptionSpec`	`getEncryptionSpec()` Immutable.
`EncryptionSpec.Builder`	`getEncryptionSpecBuilder()` Immutable.
`EncryptionSpecOrBuilder`	`getEncryptionSpecOrBuilder()` Immutable.
`String`	`getEtag()` Used to perform consistent read-modify-write updates.
`com.google.protobuf.ByteString`	`getEtagBytes()` Used to perform consistent read-modify-write updates.
`IndexStats`	`getIndexStats()` Output only.
`IndexStats.Builder`	`getIndexStatsBuilder()` Output only.
`IndexStatsOrBuilder`	`getIndexStatsOrBuilder()` Output only.
`Index.IndexUpdateMethod`	`getIndexUpdateMethod()` Immutable.
`int`	`getIndexUpdateMethodValue()` Immutable.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The labels with user-defined metadata to organize your Indexes.
`Map<String,String>`	`getLabelsMap()` The labels with user-defined metadata to organize your Indexes.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels with user-defined metadata to organize your Indexes.
`String`	`getLabelsOrThrow(String key)` The labels with user-defined metadata to organize your Indexes.
`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].
`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].
`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].
`String`	`getMetadataSchemaUri()` Immutable.
`com.google.protobuf.ByteString`	`getMetadataSchemaUriBytes()` Immutable.
`Map<String,String>`	`getMutableLabels()` Deprecated.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`boolean`	`getSatisfiesPzi()` Output only.
`boolean`	`getSatisfiesPzs()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.Timestamp.Builder`	`getUpdateTimeBuilder()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasEncryptionSpec()` Immutable.
`boolean`	`hasIndexStats()` Output only.
`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].
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMutableMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`Index.Builder`	`mergeCreateTime(com.google.protobuf.Timestamp value)` Output only.
`Index.Builder`	`mergeEncryptionSpec(EncryptionSpec value)` Immutable.
`Index.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Index.Builder`	`mergeFrom(Index other)`
`Index.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Index.Builder`	`mergeIndexStats(IndexStats value)` Output only.
`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].
`Index.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Index.Builder`	`mergeUpdateTime(com.google.protobuf.Timestamp value)` Output only.
`Index.Builder`	`putAllLabels(Map<String,String> values)` The labels with user-defined metadata to organize your Indexes.
`Index.Builder`	`putLabels(String key, String value)` The labels with user-defined metadata to organize your Indexes.
`Index.Builder`	`removeDeployedIndexes(int index)` Output only.
`Index.Builder`	`removeLabels(String key)` The labels with user-defined metadata to organize your Indexes.
`Index.Builder`	`setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)` Output only.
`Index.Builder`	`setCreateTime(com.google.protobuf.Timestamp value)` Output only.
`Index.Builder`	`setDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)` Output only.
`Index.Builder`	`setDeployedIndexes(int index, DeployedIndexRef value)` Output only.
`Index.Builder`	`setDescription(String value)` The description of the Index.
`Index.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` The description of the Index.
`Index.Builder`	`setDisplayName(String value)` Required.
`Index.Builder`	`setDisplayNameBytes(com.google.protobuf.ByteString value)` Required.
`Index.Builder`	`setEncryptionSpec(EncryptionSpec.Builder builderForValue)` Immutable.
`Index.Builder`	`setEncryptionSpec(EncryptionSpec value)` Immutable.
`Index.Builder`	`setEtag(String value)` Used to perform consistent read-modify-write updates.
`Index.Builder`	`setEtagBytes(com.google.protobuf.ByteString value)` Used to perform consistent read-modify-write updates.
`Index.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Index.Builder`	`setIndexStats(IndexStats.Builder builderForValue)` Output only.
`Index.Builder`	`setIndexStats(IndexStats value)` Output only.
`Index.Builder`	`setIndexUpdateMethod(Index.IndexUpdateMethod value)` Immutable.
`Index.Builder`	`setIndexUpdateMethodValue(int value)` Immutable.
`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].
`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].
`Index.Builder`	`setMetadataSchemaUri(String value)` Immutable.
`Index.Builder`	`setMetadataSchemaUriBytes(com.google.protobuf.ByteString value)` Immutable.
`Index.Builder`	`setName(String value)` Output only.
`Index.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` Output only.
`Index.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Index.Builder`	`setSatisfiesPzi(boolean value)` Output only.
`Index.Builder`	`setSatisfiesPzs(boolean value)` Output only.
`Index.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Index.Builder`	`setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)` Output only.
`Index.Builder`	`setUpdateTime(com.google.protobuf.Timestamp value)` Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.GeneratedMessageV3.Builder<Index.Builder>

internalGetMutableMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
```
Overrides:

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone
```
public Index.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

setField

public Index.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                              Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

clearField
```
public Index.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

clearOneof
```
public Index.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

setRepeatedField

public Index.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      int index,
                                      Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.Builder>

addRepeatedField

public Index.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Index.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.GeneratedMessageV3.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.