Package com.azure.search.documents.models

Class SearchAudience

java.lang.Object

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

com.azure.search.documents.models.SearchAudience

All Implemented Interfaces:

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

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

Cloud audiences available for Search.

Field Summary

Fields

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

Constructors

Constructor	Description
SearchAudience()	Deprecated. Use one of the constants or the fromString(String) factory method.

Method Summary

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

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) factory method.

Creates a new instance of SearchAudience without a ExpandableStringEnum.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.

Returns:

known SearchAudience values.