Package com.azure.search.documents.indexes.models

Class IndexProjectionMode

java.lang.Object

com.azure.core.util.ExpandableStringEnum<IndexProjectionMode>

com.azure.search.documents.indexes.models.IndexProjectionMode

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class IndexProjectionMode
extends com.azure.core.util.ExpandableStringEnum<IndexProjectionMode>

Defines behavior of the index projections in relation to the rest of the indexer.

Field Summary

Fields

Modifier and Type	Field	Description
static final IndexProjectionMode	INCLUDE_INDEXING_PARENT_DOCUMENTS	The source document will be written into the indexer's target index.
static final IndexProjectionMode	SKIP_INDEXING_PARENT_DOCUMENTS	The source document will be skipped from writing into the indexer's target index.

Constructor Summary

Constructors

Constructor	Description
IndexProjectionMode()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static IndexProjectionMode	fromString(String name)	Creates or finds a IndexProjectionMode from its string representation.
static Collection<IndexProjectionMode>	values()	Gets known IndexProjectionMode values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SKIP_INDEXING_PARENT_DOCUMENTS

public static final IndexProjectionMode SKIP_INDEXING_PARENT_DOCUMENTS

The source document will be skipped from writing into the indexer's target index.

INCLUDE_INDEXING_PARENT_DOCUMENTS

public static final IndexProjectionMode INCLUDE_INDEXING_PARENT_DOCUMENTS

The source document will be written into the indexer's target index. This is the default pattern.

Constructor Details

IndexProjectionMode

@Deprecated
public IndexProjectionMode()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of IndexProjectionMode value.

Method Details

fromString

public static IndexProjectionMode fromString(String name)

Creates or finds a IndexProjectionMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding IndexProjectionMode.

values

public static Collection<IndexProjectionMode> values()

Gets known IndexProjectionMode values.

Returns:

known IndexProjectionMode values.