SearchIndexPermissionFilterOption Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.2.0

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.search.documents.indexes.models.SearchIndexPermissionFilterOption

public final class SearchIndexPermissionFilterOption
extends ExpandableStringEnum<SearchIndexPermissionFilterOption>

A value indicating whether permission filtering is enabled for the index.

Field Summary

Modifier and Type	Field and Description
static final SearchIndexPermissionFilterOption	DISABLED Permission filtering is disabled for the index.
static final SearchIndexPermissionFilterOption	ENABLED Permission filtering is enabled for the index.

Constructor Summary

Constructor	Description
SearchIndexPermissionFilterOption()	Deprecated Use the fromString(String name) factory method. Creates a new instance of SearchIndexPermissionFilterOption value.

Method Summary

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

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

DISABLED

public static final SearchIndexPermissionFilterOption DISABLED

Permission filtering is disabled for the index.

ENABLED

public static final SearchIndexPermissionFilterOption ENABLED

Permission filtering is enabled for the index.

Constructor Details

SearchIndexPermissionFilterOption

@Deprecated
public SearchIndexPermissionFilterOption()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of SearchIndexPermissionFilterOption value.

Method Details

fromString

public static SearchIndexPermissionFilterOption fromString(String name)

Creates or finds a SearchIndexPermissionFilterOption from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SearchIndexPermissionFilterOption.

values

public static Collection<SearchIndexPermissionFilterOption> values()

Gets known SearchIndexPermissionFilterOption values.

Returns:

known SearchIndexPermissionFilterOption values.