Index (proto-google-cloud-aiplatform-v1beta1 0.16.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1beta1.Index

All Implemented Interfaces:

IndexOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Index
extends com.google.protobuf.GeneratedMessageV3
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
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Index.Builder` A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DEPLOYED_INDEXES_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ETAG_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`METADATA_FIELD_NUMBER`
`static int`	`METADATA_SCHEMA_URI_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` The labels with user-defined metadata to organize your Indexes.
`boolean`	`equals(Object obj)`
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static Index`	`getDefaultInstance()`
`Index`	`getDefaultInstanceForType()`
`DeployedIndexRef`	`getDeployedIndexes(int index)` Output only.
`int`	`getDeployedIndexesCount()` Output only.
`List<DeployedIndexRef>`	`getDeployedIndexesList()` Output only.
`DeployedIndexRefOrBuilder`	`getDeployedIndexesOrBuilder(int index)` Output only.
`List<? extends DeployedIndexRefOrBuilder>`	`getDeployedIndexesOrBuilderList()` Output only.
`String`	`getDescription()` The description of the Index.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` The description of the Index.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`String`	`getEtag()` Used to perform consistent read-modify-write updates.
`com.google.protobuf.ByteString`	`getEtagBytes()` Used to perform consistent read-modify-write updates.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The labels with user-defined metadata to organize your Indexes.
`Map<String,String>`	`getLabelsMap()` The labels with user-defined metadata to organize your Indexes.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels with user-defined metadata to organize your Indexes.
`String`	`getLabelsOrThrow(String key)` The labels with user-defined metadata to organize your Indexes.
`com.google.protobuf.Value`	`getMetadata()` An additional information about the Index; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].
`com.google.protobuf.ValueOrBuilder`	`getMetadataOrBuilder()` An additional information about the Index; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].
`String`	`getMetadataSchemaUri()` Immutable.
`com.google.protobuf.ByteString`	`getMetadataSchemaUriBytes()` Immutable.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`com.google.protobuf.Parser<Index>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`boolean`	`hasCreateTime()` Output only.
`int`	`hashCode()`
`boolean`	`hasMetadata()` An additional information about the Index; the schema of the metadata can be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static Index.Builder`	`newBuilder()`
`static Index.Builder`	`newBuilder(Index prototype)`
`Index.Builder`	`newBuilderForType()`
`protected Index.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Index`	`parseDelimitedFrom(InputStream input)`
`static Index`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(byte[] data)`
`static Index`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(ByteBuffer data)`
`static Index`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(com.google.protobuf.ByteString data)`
`static Index`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Index`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Index`	`parseFrom(InputStream input)`
`static Index`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Index>`	`parser()`
`Index.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

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

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_SCHEMA_URI_FIELD_NUMBER
```
public static final int METADATA_SCHEMA_URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- METADATA_FIELD_NUMBER
```
public static final int METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEPLOYED_INDEXES_FIELD_NUMBER
```
public static final int DEPLOYED_INDEXES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 Output only. The resource name of the Index.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getName in interface IndexOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Output only. The resource name of the Index.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNameBytes in interface IndexOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

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

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

Specified by:: getDisplayName in interface IndexOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

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

Specified by:: getDisplayNameBytes in interface IndexOrBuilder
Returns:: The bytes for displayName.

getDescription
```
public String getDescription()
```
```
 The description of the Index.
 
```
string description = 3;
Specified by:

getDescription in interface IndexOrBuilder

Returns:

The description.

getDescriptionBytes
```
public com.google.protobuf.ByteString getDescriptionBytes()
```
```
 The description of the Index.
 
```
string description = 3;
Specified by:

getDescriptionBytes in interface IndexOrBuilder

Returns:

The bytes for description.

getMetadataSchemaUri

public String getMetadataSchemaUri()

 Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
 information about the Index, that is specific to it. Unset if the Index
 does not have any additional information.
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.

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

Specified by:: getMetadataSchemaUri in interface IndexOrBuilder
Returns:: The metadataSchemaUri.

getMetadataSchemaUriBytes

public com.google.protobuf.ByteString getMetadataSchemaUriBytes()

 Immutable. Points to a YAML file stored on Google Cloud Storage describing additional
 information about the Index, that is specific to it. Unset if the Index
 does not have any additional information.
 The schema is defined as an OpenAPI 3.0.2 [Schema
 Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject).
 Note: The URI given on output will be immutable and probably different,
 including the URI scheme, than the one given on input. The output URI will
 point to a location where the user only has a read access.

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

Specified by:: getMetadataSchemaUriBytes in interface IndexOrBuilder
Returns:: The bytes for metadataSchemaUri.

hasMetadata

public boolean hasMetadata()

 An additional information about the Index; the schema of the metadata can
 be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].

.google.protobuf.Value metadata = 6;

Specified by:: hasMetadata in interface IndexOrBuilder
Returns:: Whether the metadata field is set.

getMetadata

public com.google.protobuf.Value getMetadata()

 An additional information about the Index; the schema of the metadata can
 be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].

.google.protobuf.Value metadata = 6;

Specified by:: getMetadata in interface IndexOrBuilder
Returns:: The metadata.

getMetadataOrBuilder

public com.google.protobuf.ValueOrBuilder getMetadataOrBuilder()

 An additional information about the Index; the schema of the metadata can
 be found in [metadata_schema][google.cloud.aiplatform.v1beta1.Index.metadata_schema_uri].

.google.protobuf.Value metadata = 6;

Specified by:: getMetadataOrBuilder in interface IndexOrBuilder

getDeployedIndexesList

public List<DeployedIndexRef> getDeployedIndexesList()

 Output only. The pointers to DeployedIndexes created from this Index.
 An Index can be only deleted if all its DeployedIndexes had been undeployed
 first.


 repeated .google.cloud.aiplatform.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getDeployedIndexesList in interface IndexOrBuilder

getDeployedIndexesOrBuilderList

public List<? extends DeployedIndexRefOrBuilder> getDeployedIndexesOrBuilderList()

 Output only. The pointers to DeployedIndexes created from this Index.
 An Index can be only deleted if all its DeployedIndexes had been undeployed
 first.


 repeated .google.cloud.aiplatform.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getDeployedIndexesOrBuilderList in interface IndexOrBuilder

getDeployedIndexesCount
```
public int getDeployedIndexesCount()
```
```
 Output only. The pointers to DeployedIndexes created from this Index.
 An Index can be only deleted if all its DeployedIndexes had been undeployed
 first.
 
```
repeated .google.cloud.aiplatform.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getDeployedIndexesCount in interface IndexOrBuilder

getDeployedIndexes

public DeployedIndexRef getDeployedIndexes(int index)

 Output only. The pointers to DeployedIndexes created from this Index.
 An Index can be only deleted if all its DeployedIndexes had been undeployed
 first.


 repeated .google.cloud.aiplatform.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getDeployedIndexes in interface IndexOrBuilder

getDeployedIndexesOrBuilder

public DeployedIndexRefOrBuilder getDeployedIndexesOrBuilder(int index)

 Output only. The pointers to DeployedIndexes created from this Index.
 An Index can be only deleted if all its DeployedIndexes had been undeployed
 first.


 repeated .google.cloud.aiplatform.v1beta1.DeployedIndexRef deployed_indexes = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getDeployedIndexesOrBuilder in interface IndexOrBuilder

getEtag

public String getEtag()

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

string etag = 8;

Specified by:: getEtag in interface IndexOrBuilder
Returns:: The etag.

getEtagBytes

public com.google.protobuf.ByteString getEtagBytes()

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

string etag = 8;

Specified by:: getEtagBytes in interface IndexOrBuilder
Returns:: The bytes for etag.