Package software.amazon.awssdk.services.sagemaker.model

Class TotalHits

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TotalHits

All Implemented Interfaces:

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

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

Represents the total number of matching results and indicates how accurate that count is.

The Value field provides the count, which may be exact or estimated. The Relation field indicates whether it's an exact figure or a lower bound. This helps understand the full scope of search results, especially when dealing with large result sets.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TotalHits.Builder

Method Summary

Modifier and Type	Method	Description
static TotalHits.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Relation	relation()	Indicates the relationship between the returned Value and the actual total number of matching results.
String	relationAsString()	Indicates the relationship between the returned Value and the actual total number of matching results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TotalHits.Builder>	serializableBuilderClass()
TotalHits.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Long	value()	The total number of matching results.

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

value

public final Long value()

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

Returns:

The total number of matching results. This value may be exact or an estimate, depending on the Relation field.

relation

public final Relation relation()

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

• EqualTo: The Value is the exact count of matching results.

• GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

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

Returns:

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

• EqualTo: The Value is the exact count of matching results.

• GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

See Also:

Relation

relationAsString

public final String relationAsString()

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

• EqualTo: The Value is the exact count of matching results.

• GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

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

Returns:

Indicates the relationship between the returned Value and the actual total number of matching results. Possible values are:

• EqualTo: The Value is the exact count of matching results.

• GreaterThanOrEqualTo: The Value is a lower bound of the actual count of matching results.

See Also:

Relation

toBuilder

public TotalHits.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TotalHits.Builder,TotalHits>

builder

public static TotalHits.Builder builder()

serializableBuilderClass

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