Interface IndexOrBuilder (3.56.0) 

public interface IndexOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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 abstract 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.

getCreateTimeOrBuilder()

public abstract 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

getDeployedIndexes(int index)

public abstract 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

getDeployedIndexesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract String getDescription()

The description of the Index.

string description = 3;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

The description of the Index.

string description = 3;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract 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 abstract 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 abstract 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.

getEncryptionSpecOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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.

getIndexStatsOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getMetadataOrBuilder()

public abstract 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 abstract 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 abstract 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.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getUpdateTimeOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.