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

Class UploadDocumentsResponse

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.UploadDocumentsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UploadDocumentsResponse.Builder,UploadDocumentsResponse>

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

Contains the response to an UploadDocuments request.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UploadDocumentsResponse.Builder

Method Summary

Modifier and Type	Method	Description
Long	adds()	The number of documents that were added to the search domain.
static UploadDocumentsResponse.Builder	builder()
Long	deletes()	The number of documents that were deleted from the search domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWarnings()	For responses, this returns true if the service returned a value for the Warnings property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UploadDocumentsResponse.Builder>	serializableBuilderClass()
String	status()	The status of an UploadDocumentsRequest.
UploadDocumentsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<DocumentServiceWarning>	warnings()	Any warnings returned by the document service about the documents being uploaded.

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 String status()

The status of an UploadDocumentsRequest.

Returns:

The status of an UploadDocumentsRequest.

adds

public final Long adds()

The number of documents that were added to the search domain.

Returns:

The number of documents that were added to the search domain.

deletes

public final Long deletes()

The number of documents that were deleted from the search domain.

Returns:

The number of documents that were deleted from the search domain.

hasWarnings

public final boolean hasWarnings()

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

warnings

public final List<DocumentServiceWarning> warnings()

Any warnings returned by the document service about the documents being uploaded.

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

Returns:

Any warnings returned by the document service about the documents being uploaded.

toBuilder

public UploadDocumentsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UploadDocumentsResponse.Builder,UploadDocumentsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static UploadDocumentsResponse.Builder builder()

serializableBuilderClass

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