Package org.hibernate.search.backend.elasticsearch

Enum ElasticsearchDistributionName

java.lang.Object

java.lang.Enum<ElasticsearchDistributionName>

org.hibernate.search.backend.elasticsearch.ElasticsearchDistributionName

All Implemented Interfaces:

Serializable, Comparable<ElasticsearchDistributionName>

public enum ElasticsearchDistributionName
extends Enum<ElasticsearchDistributionName>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AMAZON_OPENSEARCH_SERVERLESS	Amazon OpenSearch Serverless.
ELASTIC	The Elasticsearch distribution from Elastic.
OPENSEARCH	The OpenSearch distribution from the OpenSearch organization.

Method Summary

Modifier and Type	Method	Description
String	externalRepresentation()
static ElasticsearchDistributionName	fromServerResponseRepresentation(String value)
static ElasticsearchDistributionName	of(String value)
String	toString()
static ElasticsearchDistributionName	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ElasticsearchDistributionName[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ELASTIC

public static final ElasticsearchDistributionName ELASTIC

The Elasticsearch distribution from Elastic.

See: https://www.elastic.co/elasticsearch/.

OPENSEARCH

public static final ElasticsearchDistributionName OPENSEARCH

The OpenSearch distribution from the OpenSearch organization.

When used through Amazon OpenSearch Service, requires extra dependencies for authentication; refer to the reference documentation.

See: https://www.opensearch.org/.

AMAZON_OPENSEARCH_SERVERLESS

@Incubating
public static final ElasticsearchDistributionName AMAZON_OPENSEARCH_SERVERLESS

Amazon OpenSearch Serverless.

Requires extra dependencies for authentication; refer to the reference documentation.

See: https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html.

Method Details

values

public static ElasticsearchDistributionName[] 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 ElasticsearchDistributionName 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

of

public static ElasticsearchDistributionName of(String value)

fromServerResponseRepresentation

public static ElasticsearchDistributionName fromServerResponseRepresentation(String value)

toString

public String toString()

Overrides:

toString in class Enum<ElasticsearchDistributionName>

externalRepresentation

public String externalRepresentation()

Returns:

The expected string representation in configuration properties.