software.amazon.awssdk.services.kendra.model

Class AdditionalResultAttribute

java.lang.Object

software.amazon.awssdk.services.kendra.model.AdditionalResultAttribute

All Implemented Interfaces:

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

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

An attribute returned from an index query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdditionalResultAttribute.Builder

Method Summary

Modifier and Type	Method and Description
static AdditionalResultAttribute.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key() The key that identifies the attribute.
List<SdkField<?>>	sdkFields()
static Class<? extends AdditionalResultAttribute.Builder>	serializableBuilderClass()
AdditionalResultAttribute.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
AdditionalResultAttributeValue	value() An object that contains the attribute value.
AdditionalResultAttributeValueType	valueType() The data type of the Value property.
String	valueTypeAsString() The data type of the Value property.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

key

public final String key()

The key that identifies the attribute.

Returns:

The key that identifies the attribute.

valueType

public final AdditionalResultAttributeValueType valueType()

The data type of the Value property.

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

Returns:

The data type of the Value property.

See Also:

AdditionalResultAttributeValueType

valueTypeAsString

public final String valueTypeAsString()

The data type of the Value property.

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

Returns:

The data type of the Value property.

See Also:

AdditionalResultAttributeValueType

value

public final AdditionalResultAttributeValue value()

An object that contains the attribute value.

Returns:

An object that contains the attribute value.

toBuilder

public AdditionalResultAttribute.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AdditionalResultAttribute.Builder,AdditionalResultAttribute>

Returns:

a builder for type T

builder

public static AdditionalResultAttribute.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.