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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TotalHits.Builderrelation(String relation)Indicates the relationship between the returnedValueand the actual total number of matching results.TotalHits.Builderrelation(Relation relation)Indicates the relationship between the returnedValueand the actual total number of matching results.TotalHits.Buildervalue(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 Detail
-
value
TotalHits.Builder value(Long value)
The total number of matching results. This value may be exact or an estimate, depending on the
Relationfield.- Parameters:
value- The total number of matching results. This value may be exact or an estimate, depending on theRelationfield.- 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
Valueand the actual total number of matching results. Possible values are:-
EqualTo: TheValueis the exact count of matching results. -
GreaterThanOrEqualTo: TheValueis a lower bound of the actual count of matching results.
- Parameters:
relation- Indicates the relationship between the returnedValueand the actual total number of matching results. Possible values are:-
EqualTo: TheValueis the exact count of matching results. -
GreaterThanOrEqualTo: TheValueis 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
Valueand the actual total number of matching results. Possible values are:-
EqualTo: TheValueis the exact count of matching results. -
GreaterThanOrEqualTo: TheValueis a lower bound of the actual count of matching results.
- Parameters:
relation- Indicates the relationship between the returnedValueand the actual total number of matching results. Possible values are:-
EqualTo: TheValueis the exact count of matching results. -
GreaterThanOrEqualTo: TheValueis 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
-
-
-