Class Schema (2.0.0) 

public final class Schema

Contains information about the kinds of document Fields which are supported by the Index. 


   // Get the searchService for the default namespace
   SearchService searchService = SearchServiceFactory.getSearchService();

   // Get the first page of indexes available and retrieve schemas
   GetResponse<Index> response = searchService.getIndexes(
       GetIndexesRequest.newBuilder().setSchemaFetched(true).build());

   // List out elements of Schema
   for (Index index : response) {
     Schema schema = index.getSchema();
     for (String fieldName : schema.getFieldNames()) {
        List<FieldType> typesForField = schema.getFieldTypes(fieldName);
     }
   }

Inheritance

Object > Schema

Static Methods

newBuilder()

public static Schema.Builder newBuilder()

Creates a schema builder.

Returns
Type Description
Schema.Builder

a new builder for creating a schema

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getFieldNames()

public Set<String> getFieldNames()
Returns
Type Description
Set<String>

the set of field names supported in the schema

getFieldTypes(String fieldName)

public List<Field.FieldType> getFieldTypes(String fieldName)
Parameter
Name Description
fieldName String

the name of the field to return supported types
Returns
Type Description
List<FieldType>

a list of Field.FieldType supported for the given field name. The returned list will be empty if the schema has no field with the given name.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

toString()

public String toString()
Returns
Type Description
String
Overrides