Class Index.Builder (3.55.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.v1beta1.Index

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.Builder

Implements

IndexOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.DeployedIndexRef>
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value DeployedIndexRef
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue DeployedIndexRef.Builder
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DeployedIndexRef
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DeployedIndexRef.Builder
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
DeployedIndexRef.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

build()

public Index build()
Returns
Type Description
Index

buildPartial()

public Index buildPartial()
Returns
Type Description
Index

clear()

public Index.Builder clear()
Returns
Type Description
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
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.Builder

clearDescription()

public Index.Builder clearDescription()

The description of the Index.

string description = 3;

Returns
Type Description
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
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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
Type Description
Index.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Index.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Index.Builder
Overrides

clearIndexStats()

public Index.Builder clearIndexStats()

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Index.Builder

This builder for chaining.

clearLabels()

public Index.Builder clearLabels()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
Index.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Index.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Index.Builder
Overrides

clearSatisfiesPzi()

public Index.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Index.Builder

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
Type Description
Index.Builder

This builder for chaining.

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.v1beta1.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
Type Description
Index.Builder

clone()

public Index.Builder clone()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Index getDefaultInstanceForType()
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.DeployedIndexRefOrBuilder>

getDescription()

public String getDescription()

The description of the Index.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

The description of the Index.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for etag.

getIndexStats()

public IndexStats getIndexStats()

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IndexStats

The indexStats.

getIndexStatsBuilder()

public IndexStats.Builder getIndexStatsBuilder()

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IndexStats.Builder

getIndexStatsOrBuilder()

public IndexStatsOrBuilder getIndexStatsOrBuilder()

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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.v1beta1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
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.v1beta1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for indexUpdateMethod.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue String
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for metadataSchemaUri.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

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.v1beta1.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
Type Description
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.v1beta1.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
Type Description
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.v1beta1.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
Type Description
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
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the encryptionSpec field is set.

hasIndexStats()

public boolean hasIndexStats()

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
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
Type Description
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.v1beta1.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
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
Index.Builder

mergeFrom(Index other)

public Index.Builder mergeFrom(Index other)
Parameter
Name Description
other Index
Returns
Type Description
Index.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Index.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Index.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Index.Builder
Overrides

mergeIndexStats(IndexStats value)

public Index.Builder mergeIndexStats(IndexStats value)

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value IndexStats
Returns
Type Description
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
Name Description
value Value
Returns
Type Description
Index.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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.v1beta1.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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
values Map<String,String>
Returns
Type Description
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
Name Description
key String
value String
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
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
Name Description
key String
Returns
Type Description
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
Name Description
value Timestamp
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value DeployedIndexRef
Returns
Type Description
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.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue DeployedIndexRef.Builder
Returns
Type Description
Index.Builder

setDescription(String value)

public Index.Builder setDescription(String value)

The description of the Index.

string description = 3;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Index.Builder setDescriptionBytes(ByteString value)

The description of the Index.

string description = 3;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
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
Name Description
value String

The displayName to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value EncryptionSpec
Returns
Type Description
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.v1beta1.EncryptionSpec encryption_spec = 17 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
builderForValue EncryptionSpec.Builder
Returns
Type Description
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
Name Description
value String

The etag to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Index.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Index.Builder
Overrides

setIndexStats(IndexStats value)

public Index.Builder setIndexStats(IndexStats value)

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value IndexStats
Returns
Type Description
Index.Builder

setIndexStats(IndexStats.Builder builderForValue)

public Index.Builder setIndexStats(IndexStats.Builder builderForValue)

Output only. Stats of the index resource.

.google.cloud.aiplatform.v1beta1.IndexStats index_stats = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue IndexStats.Builder
Returns
Type Description
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.v1beta1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value Index.IndexUpdateMethod

The indexUpdateMethod to set.
Returns
Type Description
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.v1beta1.Index.IndexUpdateMethod index_update_method = 16 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value int

The enum numeric value on the wire for indexUpdateMethod to set.
Returns
Type Description
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
Name Description
value Value
Returns
Type Description
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
Name Description
builderForValue Builder
Returns
Type Description
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
Name Description
value String

The metadataSchemaUri to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for metadataSchemaUri to set.
Returns
Type Description
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
Name Description
value String

The name to set.
Returns
Type Description
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
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
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
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Index.Builder
Overrides

setSatisfiesPzi(boolean value)

public Index.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

bool satisfies_pzi = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public Index.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

bool satisfies_pzs = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
Index.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Index.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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.v1beta1.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
Name Description
value Timestamp
Returns
Type Description
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.v1beta1.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
Name Description
builderForValue Builder
Returns
Type Description
Index.Builder