Package software.amazon.awssdk.services.cloudsearchdomain.model

Class SearchResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudsearchdomain.model.CloudSearchDomainResponse

software.amazon.awssdk.services.cloudsearchdomain.model.SearchResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchResponse.Builder,SearchResponse>

@Generated("software.amazon.awssdk:codegen")
public final class SearchResponse
extends CloudSearchDomainResponse
implements ToCopyableBuilder<SearchResponse.Builder,SearchResponse>

The result of a Search request. Contains the documents that match the specified search criteria and any requested fields, highlights, and facet information.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchResponse.Builder

Method Summary

Modifier and Type	Method	Description
static SearchResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,BucketInfo>	facets()	The requested facet information.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacets()	For responses, this returns true if the service returned a value for the Facets property.
int	hashCode()
boolean	hasStats()	For responses, this returns true if the service returned a value for the Stats property.
Hits	hits()	The documents that match the search criteria.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchResponse.Builder>	serializableBuilderClass()
Map<String,FieldStats>	stats()	The requested field statistics information.
SearchStatus	status()	The status information returned for the search request.
SearchResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudsearchdomain.model.CloudSearchDomainResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

status

public final SearchStatus status()

The status information returned for the search request.

Returns:

The status information returned for the search request.

hits

public final Hits hits()

The documents that match the search criteria.

Returns:

The documents that match the search criteria.

hasFacets

public final boolean hasFacets()

For responses, this returns true if the service returned a value for the Facets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

facets

public final Map<String,BucketInfo> facets()

The requested facet information.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFacets() method.

Returns:

The requested facet information.

hasStats

public final boolean hasStats()

For responses, this returns true if the service returned a value for the Stats property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stats

public final Map<String,FieldStats> stats()

The requested field statistics information.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStats() method.

Returns:

The requested field statistics information.

toBuilder

public SearchResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchResponse.Builder,SearchResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static SearchResponse.Builder builder()

serializableBuilderClass

public static Class<? extends SearchResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

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