DescIndexResponseWrapper

java.lang.Object
- io.milvus.response.DescIndexResponseWrapper

public class DescIndexResponseWrapper
extends java.lang.Object

Util class to wrap response of describeIndex interface.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DescIndexResponseWrapper.IndexDesc
Internal-use class to wrap response of describeIndex interface.

Constructor Summary

Constructors
Constructor Description

DescIndexResponseWrapper(@NonNull io.milvus.grpc.DescribeIndexResponse response)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DescIndexResponseWrapper.IndexDesc`	`getIndexDescByFieldName(@NonNull java.lang.String fieldName)`	Get index description by field name.
`java.util.List<DescIndexResponseWrapper.IndexDesc>`	`getIndexDescriptions()`	Get index description of fields.
`java.lang.String`	`toString()`	Construct a `String` by `DescIndexResponseWrapper` instance.

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

- Constructor Detail
  - DescIndexResponseWrapper
```
public DescIndexResponseWrapper(@NonNull
                                @NonNull io.milvus.grpc.DescribeIndexResponse response)
```
- Method Detail
  - getIndexDescriptions
```
public java.util.List<DescIndexResponseWrapper.IndexDesc> getIndexDescriptions()
```
    Get index description of fields.
    
    Returns:
    
    List of IndexDesc, index description of fields
  - getIndexDescByFieldName
```
public DescIndexResponseWrapper.IndexDesc getIndexDescByFieldName(@NonNull
                                                                  @NonNull java.lang.String fieldName)
```
    Get index description by field name. Return null if the field doesn't exist
    
    Parameters:
    
    fieldName - field name to get index description
    
    Returns:
    
    DescIndexResponseWrapper.IndexDesc description of the index
  - toString
```
public java.lang.String toString()
```
    Construct a String by DescIndexResponseWrapper instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    String