Class Index.Builder (3.41.0)

public static final class Index.Builder extends 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

Implements

IndexOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDeployedIndexes(Iterable<? extends DeployedIndexRef> values)

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

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.aiplatform.v1.DeployedIndexRef>
Returns
TypeDescription
Index.Builder

addDeployedIndexes(DeployedIndexRef value)

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

Parameter
NameDescription
valueDeployedIndexRef
Returns
TypeDescription
Index.Builder

addDeployedIndexes(DeployedIndexRef.Builder builderForValue)

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

Parameter
NameDescription
builderForValueDeployedIndexRef.Builder
Returns
TypeDescription
Index.Builder

addDeployedIndexes(int index, DeployedIndexRef value)

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

Parameters
NameDescription
indexint
valueDeployedIndexRef
Returns
TypeDescription
Index.Builder

addDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueDeployedIndexRef.Builder
Returns
TypeDescription
Index.Builder

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

Returns
TypeDescription
DeployedIndexRef.Builder

addDeployedIndexesBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedIndexRef.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Index.Builder
Overrides

build()

public Index build()
Returns
TypeDescription
Index

buildPartial()

public Index buildPartial()
Returns
TypeDescription
Index

clear()

public Index.Builder clear()
Returns
TypeDescription
Index.Builder
Overrides

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

Returns
TypeDescription
Index.Builder

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

Returns
TypeDescription
Index.Builder

clearDescription()

public Index.Builder clearDescription()

The description of the Index.

string description = 3;

Returns
TypeDescription
Index.Builder

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

This builder for chaining.

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

Returns
TypeDescription
Index.Builder

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Index.Builder
Overrides

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

Returns
TypeDescription
Index.Builder

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

This builder for chaining.

clearLabels()

public Index.Builder clearLabels()
Returns
TypeDescription
Index.Builder

clearMetadata()

public Index.Builder clearMetadata()

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Returns
TypeDescription
Index.Builder

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

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Index.Builder
Overrides

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

Returns
TypeDescription
Index.Builder

clone()

public Index.Builder clone()
Returns
TypeDescription
Index.Builder
Overrides

containsLabels(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
TypeDescription
Index

getDeployedIndexes(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedIndexRef

getDeployedIndexesBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedIndexRef.Builder

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

Returns
TypeDescription
List<Builder>

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

Returns
TypeDescription
int

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

Returns
TypeDescription
List<DeployedIndexRef>

getDeployedIndexesOrBuilder(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
DeployedIndexRefOrBuilder

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

Returns
TypeDescription
List<? extends com.google.cloud.aiplatform.v1.DeployedIndexRefOrBuilder>

getDescription()

public String getDescription()

The description of the Index.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Index.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for displayName.

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

Returns
TypeDescription
EncryptionSpec

The encryptionSpec.

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

Returns
TypeDescription
EncryptionSpec.Builder

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

Returns
TypeDescription
EncryptionSpecOrBuilder

getEtag()

public String getEtag()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8;

Returns
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8;

Returns
TypeDescription
ByteString

The bytes for etag.

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

Returns
TypeDescription
IndexStats

The indexStats.

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

Returns
TypeDescription
IndexStats.Builder

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

Returns
TypeDescription
IndexStatsOrBuilder

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

Returns
TypeDescription
Index.IndexUpdateMethod

The indexUpdateMethod.

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

Returns
TypeDescription
int

The enum numeric value on the wire for indexUpdateMethod.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

The labels with user-defined metadata to organize your Indexes.

Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed.

See https://goo.gl/xmQnxf for more information and examples of labels.

map<string, string> labels = 9;

Returns
TypeDescription
int

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;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMetadata()

public Value getMetadata()

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Returns
TypeDescription
Value

The metadata.

getMetadataBuilder()

public Value.Builder getMetadataBuilder()

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Returns
TypeDescription
Builder

getMetadataOrBuilder()

public ValueOrBuilder getMetadataOrBuilder()

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Returns
TypeDescription
ValueOrBuilder

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. 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
TypeDescription
String

The metadataSchemaUri.

getMetadataSchemaUriBytes()

public ByteString getMetadataSchemaUriBytes()

Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access.

string metadata_schema_uri = 4 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for metadataSchemaUri.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public String getName()

Output only. The resource name of the Index.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name of the Index.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the createTime field is set.

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

Returns
TypeDescription
boolean

Whether the encryptionSpec field is set.

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

Returns
TypeDescription
boolean

Whether the indexStats field is set.

hasMetadata()

public boolean hasMetadata()

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Returns
TypeDescription
boolean

Whether the metadata field is set.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCreateTime(Timestamp value)

public Index.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Index.Builder

mergeEncryptionSpec(EncryptionSpec value)

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

Parameter
NameDescription
valueEncryptionSpec
Returns
TypeDescription
Index.Builder

mergeFrom(Index other)

public Index.Builder mergeFrom(Index other)
Parameter
NameDescription
otherIndex
Returns
TypeDescription
Index.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Index.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Index.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Index.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Index.Builder
Overrides

mergeIndexStats(IndexStats value)

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

Parameter
NameDescription
valueIndexStats
Returns
TypeDescription
Index.Builder

mergeMetadata(Value value)

public Index.Builder mergeMetadata(Value value)

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Parameter
NameDescription
valueValue
Returns
TypeDescription
Index.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Index.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Index.Builder mergeUpdateTime(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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Index.Builder

putAllLabels(Map<String,String> values)

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;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Index.Builder

putLabels(String key, String value)

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;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Index.Builder

removeDeployedIndexes(int index)

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Index.Builder

removeLabels(String key)

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
Index.Builder

setCreateTime(Timestamp value)

public Index.Builder setCreateTime(Timestamp value)

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Index.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Index.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp when this Index was created.

.google.protobuf.Timestamp create_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Index.Builder

setDeployedIndexes(int index, DeployedIndexRef value)

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

Parameters
NameDescription
indexint
valueDeployedIndexRef
Returns
TypeDescription
Index.Builder

setDeployedIndexes(int index, DeployedIndexRef.Builder builderForValue)

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

Parameters
NameDescription
indexint
builderForValueDeployedIndexRef.Builder
Returns
TypeDescription
Index.Builder

setDescription(String value)

public Index.Builder setDescription(String value)

The description of the Index.

string description = 3;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Index.Builder setDescriptionBytes(ByteString value)

The description of the Index.

string description = 3;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setDisplayName(String value)

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

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Index.Builder setDisplayNameBytes(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];

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setEncryptionSpec(EncryptionSpec value)

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

Parameter
NameDescription
valueEncryptionSpec
Returns
TypeDescription
Index.Builder

setEncryptionSpec(EncryptionSpec.Builder builderForValue)

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

Parameter
NameDescription
builderForValueEncryptionSpec.Builder
Returns
TypeDescription
Index.Builder

setEtag(String value)

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;

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Index.Builder setEtagBytes(ByteString value)

Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

string etag = 8;

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Index.Builder
Overrides

setIndexStats(IndexStats value)

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

Parameter
NameDescription
valueIndexStats
Returns
TypeDescription
Index.Builder

setIndexStats(IndexStats.Builder builderForValue)

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

Parameter
NameDescription
builderForValueIndexStats.Builder
Returns
TypeDescription
Index.Builder

setIndexUpdateMethod(Index.IndexUpdateMethod value)

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

Parameter
NameDescription
valueIndex.IndexUpdateMethod

The indexUpdateMethod to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setIndexUpdateMethodValue(int value)

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for indexUpdateMethod to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setMetadata(Value value)

public Index.Builder setMetadata(Value value)

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Parameter
NameDescription
valueValue
Returns
TypeDescription
Index.Builder

setMetadata(Value.Builder builderForValue)

public Index.Builder setMetadata(Value.Builder builderForValue)

An additional information about the Index; the schema of the metadata can be found in metadata_schema.

.google.protobuf.Value metadata = 6;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Index.Builder

setMetadataSchemaUri(String value)

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

Parameter
NameDescription
valueString

The metadataSchemaUri to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setMetadataSchemaUriBytes(ByteString value)

public Index.Builder setMetadataSchemaUriBytes(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. 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];

Parameter
NameDescription
valueByteString

The bytes for metadataSchemaUri to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setName(String value)

public Index.Builder setName(String value)

Output only. The resource name of the Index.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Index.Builder setNameBytes(ByteString value)

Output only. The resource name of the Index.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Index.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Index.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Index.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Index.Builder
Overrides

setUpdateTime(Timestamp value)

public Index.Builder setUpdateTime(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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Index.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Index.Builder setUpdateTime(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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Index.Builder