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

Class InsightEntity

java.lang.Object

software.amazon.awssdk.services.opensearch.model.InsightEntity

All Implemented Interfaces:

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

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

Specifies the entity for which to retrieve insights. An entity can be an Amazon OpenSearch Service domain or an Amazon Web Services account.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InsightEntity.Builder

Method Summary

Modifier and Type	Method	Description
static InsightEntity.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InsightEntity.Builder>	serializableBuilderClass()
InsightEntity.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final InsightEntityType	type()	The type of the entity.
final String	typeAsString()	The type of the entity.
final String	value()	The value of the entity.

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 Details

type

public final InsightEntityType type()

The type of the entity. Possible values are Account and DomainName.

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

Returns:

The type of the entity. Possible values are Account and DomainName.

See Also:

• InsightEntityType

typeAsString

public final String typeAsString()

The type of the entity. Possible values are Account and DomainName.

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

Returns:

The type of the entity. Possible values are Account and DomainName.

See Also:

• InsightEntityType

value

public final String value()

The value of the entity. For DomainName, this is the domain name. For Account, this is the Amazon Web Services account ID.

Returns:

The value of the entity. For DomainName, this is the domain name. For Account, this is the Amazon Web Services account ID.

toBuilder

public InsightEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InsightEntity.Builder,InsightEntity>

builder

public static InsightEntity.Builder builder()

serializableBuilderClass

public static Class<? extends InsightEntity.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