Package software.amazon.awssdk.services.opensearch.model

Class DomainInfo

java.lang.Object

software.amazon.awssdk.services.opensearch.model.DomainInfo

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainInfo.Builder,DomainInfo>

@Generated("software.amazon.awssdk:codegen")
public final class DomainInfo
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DomainInfo.Builder,DomainInfo>

Information about an OpenSearch Service domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainInfo.Builder

Method Summary

Modifier and Type	Method	Description
static DomainInfo.Builder	builder()
String	domainName()	Name of the domain.
EngineType	engineType()	The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
String	engineTypeAsString()	The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DomainInfo.Builder>	serializableBuilderClass()
DomainInfo.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

domainName

public final String domainName()

Name of the domain.

Returns:

Name of the domain.

engineType

public final EngineType engineType()

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

See Also:

EngineType

engineTypeAsString

public final String engineTypeAsString()

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

If the service returns an enum value that is not available in the current SDK version, engineType will return EngineType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from engineTypeAsString().

Returns:

The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

See Also:

EngineType

toBuilder

public DomainInfo.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DomainInfo.Builder,DomainInfo>

builder

public static DomainInfo.Builder builder()

serializableBuilderClass

public static Class<? extends DomainInfo.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo