IndexSpec.Builder (AppEngine :: appengine-apis 2.0.17 API)

java.lang.Object
- com.google.appengine.api.search.IndexSpec.Builder

Enclosing class:: IndexSpec

public static final class IndexSpec.Builder
extends Object

A builder of IndexSpec.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IndexSpec`	`build()`	Builds a valid IndexSpec.
`IndexSpec.Builder`	`setName(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(String name)
```
    Sets the unique name of the index.
    
    Parameters:
    
    name - the name of the index
    
    Returns:
    
    this Builder
    
    Throws:
    
    IllegalArgumentException - if the index name length is not between 1 and IndexChecker#MAXIMUM_INDEX_NAME_LENGTH
  - 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:
    
    IllegalArgumentException - if the IndexSpec built is not valid