Interface TotalHits.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TotalHits.Builder,TotalHits>, SdkBuilder<TotalHits.Builder,TotalHits>, SdkPojo

Enclosing class:

TotalHits

@Mutable
@NotThreadSafe
public static interface TotalHits.Builder
extends SdkPojo, CopyableBuilder<TotalHits.Builder,TotalHits>

Method Summary

Modifier and Type	Method	Description
TotalHits.Builder	relation(String relation)	Indicates the relationship between the returned Value and the actual total number of matching results.
TotalHits.Builder	relation(Relation relation)	Indicates the relationship between the returned Value and the actual total number of matching results.
TotalHits.Builder	value(Long value)	The total number of matching results.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

value

TotalHits.Builder value(Long value)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relation

TotalHits.Builder relation(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Relation
• Relation

relation

TotalHits.Builder relation(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• Relation
• Relation