IndexingDirective (Azure SDK for Java Reference Documentation)

java.lang.Object
- java.lang.Enum<IndexingDirective>
- - com.azure.data.cosmos.IndexingDirective

All Implemented Interfaces:

Serializable, Comparable<IndexingDirective>
```
public enum IndexingDirective
extends Enum<IndexingDirective>
```
Specifies whether or not the resource is to be indexed in the Azure Cosmos DB database service.

Enum Constant Summary

Enum Constants
Enum Constant Description

DEFAULT
Use any pre-defined/pre-configured defaults.

EXCLUDE
Do not index the resource.

INCLUDE
Index the resource.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`toString()`
`static IndexingDirective`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static IndexingDirective[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - DEFAULT
```
public static final IndexingDirective DEFAULT
```
    Use any pre-defined/pre-configured defaults.
  - INCLUDE
```
public static final IndexingDirective INCLUDE
```
    Index the resource.
  - EXCLUDE
```
public static final IndexingDirective EXCLUDE
```
    Do not index the resource.
- Method Detail
  - values
```
public static IndexingDirective[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (IndexingDirective c : IndexingDirective.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static IndexingDirective valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<IndexingDirective>