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

Class InsightField

java.lang.Object

software.amazon.awssdk.services.opensearch.model.InsightField

All Implemented Interfaces:

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

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

Represents a field in the detailed view of an insight, returned by the DescribeInsightDetails operation.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InsightField.Builder

Method Summary

Modifier and Type	Method	Description
static InsightField.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 String	name()	The name of the insight field.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends InsightField.Builder>	serializableBuilderClass()
InsightField.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final InsightFieldType	type()	The type of the insight field.
final String	typeAsString()	The type of the insight field.
final String	value()	The value of the insight field.

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

name

public final String name()

The name of the insight field.

Returns:

The name of the insight field.

type

public final InsightFieldType type()

The type of the insight field. Possible values are text and metric.

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

Returns:

The type of the insight field. Possible values are text and metric.

See Also:

• InsightFieldType

typeAsString

public final String typeAsString()

The type of the insight field. Possible values are text and metric.

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

Returns:

The type of the insight field. Possible values are text and metric.

See Also:

• InsightFieldType

value

public final String value()

The value of the insight field.

Returns:

The value of the insight field.

toBuilder

public InsightField.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InsightField.Builder,InsightField>

builder

public static InsightField.Builder builder()

serializableBuilderClass

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