Class PermissionFilter

java.lang.Object

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

com.azure.search.documents.indexes.models.PermissionFilter

All Implemented Interfaces:

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

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

A value indicating whether the field should be used as a permission filter.

Field Summary

Fields

Modifier and Type	Field	Description
static final PermissionFilter	GROUP_IDS	Field represents group IDs that should be used to filter document access on queries.
static final PermissionFilter	RBAC_SCOPE	Field represents an RBAC scope that should be used to filter document access on queries.
static final PermissionFilter	USER_IDS	Field represents user IDs that should be used to filter document access on queries.

Constructor Summary

Constructors

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

Method Summary

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

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

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class Object

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

Field Details

USER_IDS

public static final PermissionFilter USER_IDS

Field represents user IDs that should be used to filter document access on queries.

GROUP_IDS

public static final PermissionFilter GROUP_IDS

Field represents group IDs that should be used to filter document access on queries.

RBAC_SCOPE

public static final PermissionFilter RBAC_SCOPE

Field represents an RBAC scope that should be used to filter document access on queries.

Constructor Details

PermissionFilter

@Deprecated
public PermissionFilter()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of PermissionFilter value.

Method Details

fromString

public static PermissionFilter fromString(String name)

Creates or finds a PermissionFilter from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding PermissionFilter.

values

public static Collection<PermissionFilter> values()

Gets known PermissionFilter values.

Returns:

known PermissionFilter values.