Package com.azure.search.documents

Enum SearchServiceVersion

java.lang.Object

java.lang.Enum<SearchServiceVersion>

com.azure.search.documents.SearchServiceVersion

All Implemented Interfaces:

com.azure.core.util.ServiceVersion, Serializable, Comparable<SearchServiceVersion>, java.lang.constant.Constable

public enum SearchServiceVersion
extends Enum<SearchServiceVersion>
implements com.azure.core.util.ServiceVersion

The versions of Azure AI Search supported by this client library.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
V2020_06_30	2020-06-30 service version.
V2023_11_01	2023-11-01 service version.
V2024_07_01	2024-07-01 service version.
V2025_03_01_PREVIEW	2024-11-01-preview service version.

Method Summary

Modifier and Type	Method	Description
static SearchServiceVersion	getLatest()	Gets the latest service version supported by this client library.
String	getVersion()
static SearchServiceVersion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SearchServiceVersion[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

V2020_06_30

public static final SearchServiceVersion V2020_06_30

2020-06-30 service version.

V2023_11_01

public static final SearchServiceVersion V2023_11_01

2023-11-01 service version.

V2024_07_01

public static final SearchServiceVersion V2024_07_01

2024-07-01 service version.

V2025_03_01_PREVIEW

public static final SearchServiceVersion V2025_03_01_PREVIEW

2024-11-01-preview service version.

Method Details

values

public static SearchServiceVersion[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SearchServiceVersion valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getVersion

public String getVersion()

Specified by:

getVersion in interface com.azure.core.util.ServiceVersion

getLatest

public static SearchServiceVersion getLatest()

Gets the latest service version supported by this client library.

Returns:

The latest version supported by this client library.