com.google.appengine.api.search
Class IndexSpec.Builder

java.lang.Object
  extended by com.google.appengine.api.search.IndexSpec.Builder
Enclosing class:
IndexSpec

public static final class IndexSpec.Builder
extends java.lang.Object

A builder of IndexSpec.


Method Summary
 IndexSpec build()
          Builds a valid IndexSpec.
 IndexSpec.Builder setConsistency(Consistency consistency)
          Sets the consistency mode in which the index operates.
 IndexSpec.Builder setName(java.lang.String name)
          Sets the unique name of the index.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

setName

public IndexSpec.Builder setName(java.lang.String name)
Sets the unique name of the index.

Parameters:
name - the name of the index
Throws:
java.lang.IllegalArgumentException - if the index name length is not between 1 and IndexChecker#MAXIMUM_INDEX_NAME_LENGTH

setConsistency

public IndexSpec.Builder setConsistency(Consistency consistency)
Sets the consistency mode in which the index operates.

Parameters:
consistency - the consistency mode in which the index operates

build

public IndexSpec build()
Builds a valid IndexSpec. The builder must have set a valid index name.

Returns:
the IndexSpec built by this builder
Throws:
java.lang.IllegalArgumentException - if the IndexSpec built is not valid