Package software.amazon.awssdk.services.cloudsearch.model

Class IndexDocumentsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudsearch.model.CloudSearchResponse

software.amazon.awssdk.services.cloudsearch.model.IndexDocumentsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<IndexDocumentsResponse.Builder,IndexDocumentsResponse>

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

The result of an IndexDocuments request. Contains the status of the indexing operation, including the fields being indexed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexDocumentsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static IndexDocumentsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	fieldNames()	The names of the fields that are currently being indexed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldNames()	For responses, this returns true if the service returned a value for the FieldNames property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends IndexDocumentsResponse.Builder>	serializableBuilderClass()
IndexDocumentsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudsearch.model.CloudSearchResponse

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

hasFieldNames

public final boolean hasFieldNames()

For responses, this returns true if the service returned a value for the FieldNames 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.

fieldNames

public final List<String> fieldNames()

The names of the fields that are currently being indexed.

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 hasFieldNames() method.

Returns:

The names of the fields that are currently being indexed.

toBuilder

public IndexDocumentsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IndexDocumentsResponse.Builder,IndexDocumentsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static IndexDocumentsResponse.Builder builder()

serializableBuilderClass

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