PermissionFilter Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.9.0-beta.1

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

public final class PermissionFilter
extends ExpandableStringEnum<PermissionFilter>

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

Field Summary

Modifier and Type	Field and 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

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

Method Summary

Modifier and Type	Method and 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 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

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.

USER_IDS

public static final PermissionFilter USER_IDS

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

Constructor Details

PermissionFilter

@Deprecated
public PermissionFilter()

Deprecated

Use the fromString(String name) 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.