Package org.opensearch

Class Build

java.lang.Object

org.opensearch.Build

public class Build
extends Object

Information about a build of OpenSearch.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Build.Type	The type of build

Field Summary

Fields

Modifier and Type	Field	Description
static final Build	CURRENT	The current build of OpenSearch.

Constructor Summary

Constructors

Constructor	Description
Build(Build.Type type, String hash, String date, boolean isSnapshot, String version, String distribution)

Method Summary

Modifier and Type	Method	Description
String	date()
boolean	equals(Object o)
String	getDistribution()	Get the distribution name (expected to be OpenSearch; empty if legacy; something else if forked)
String	getQualifiedVersion()	Get the version as considered at build time
String	hash()
int	hashCode()
boolean	isProductionRelease()	Provides information about the intent of the build
boolean	isSnapshot()
String	toString()
Build.Type	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

CURRENT

public static final Build CURRENT

The current build of OpenSearch. Filled with information scanned at startup from the jar.

Constructor Details

Build

public Build(Build.Type type,
 String hash,
 String date,
 boolean isSnapshot,
 String version,
 String distribution)

Method Details

hash

public String hash()

date

public String date()

getDistribution

public String getDistribution()

Get the distribution name (expected to be OpenSearch; empty if legacy; something else if forked)

Returns:

distribution name as a string

getQualifiedVersion

public String getQualifiedVersion()

Get the version as considered at build time

Offers a way to get the fully qualified version as configured by the build. This will be the same as Version for production releases, but may include on of the qualifier ( e.x alpha1 ) or -SNAPSHOT for others.

Returns:

the fully qualified build

type

public Build.Type type()

isSnapshot

public boolean isSnapshot()

isProductionRelease

public boolean isProductionRelease()

Provides information about the intent of the build

Returns:

true if the build is intended for production use

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object