SearchAudience Class

Package:: com.azure.search.documents.models

Maven Artifact:: com.azure:azure-search-documents:11.8.1

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.search.documents.models.SearchAudience

public final class SearchAudience
extends ExpandableStringEnum<SearchAudience>

Cloud audiences available for Search.

Field Summary

Modifier and Type	Field and Description
static final SearchAudience	AZURE_CHINA The SearchAudience for Azure China cloud.
static final SearchAudience	AZURE_GOVERNMENT The SearchAudience for Azure US Government cloud.
static final SearchAudience	AZURE_PUBLIC_CLOUD The SearchAudience for the Azure Public cloud.

Constructor Summary

Constructor	Description
SearchAudience()	Deprecated Use one of the constants or the fromString(String name) factory method. Creates a new instance of SearchAudience without a #toString() value.

Constructor

Description

SearchAudience()

Deprecated

Use one of the constants or the fromString(String name) factory method.

Creates a new instance of SearchAudience without a #toString() value.

Method Summary

Modifier and Type	Method and Description
static SearchAudience	fromString(String name) Creates or finds a SearchAudience from its string representation.
static Collection<SearchAudience>	values() Gets the known SearchAudience 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

AZURE_CHINA

public static final SearchAudience AZURE_CHINA

The SearchAudience for Azure China cloud.

AZURE_GOVERNMENT

public static final SearchAudience AZURE_GOVERNMENT

The SearchAudience for Azure US Government cloud.

AZURE_PUBLIC_CLOUD

public static final SearchAudience AZURE_PUBLIC_CLOUD

The SearchAudience for the Azure Public cloud.

Constructor Details

SearchAudience

@Deprecated
public SearchAudience()

Deprecated

Use one of the constants or the fromString(String name) factory method.

Creates a new instance of SearchAudience without a #toString() value.

This constructor shouldn't be called as it will produce a SearchAudience which doesn't have a String enum value.

Method Details

fromString

public static SearchAudience fromString(String name)

Creates or finds a SearchAudience from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding SearchAudience.

values

public static Collection<SearchAudience> values()

Gets the known SearchAudience values.