Package software.amazon.awssdk.services.rekognition.model

Class DeleteFacesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rekognition.model.RekognitionResponse

software.amazon.awssdk.services.rekognition.model.DeleteFacesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DeleteFacesResponse.Builder,DeleteFacesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeleteFacesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DeleteFacesResponse.Builder	builder()
List<String>	deletedFaces()	An array of strings (face IDs) of the faces that were deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeletedFaces()	For responses, this returns true if the service returned a value for the DeletedFaces property.
int	hashCode()
boolean	hasUnsuccessfulFaceDeletions()	For responses, this returns true if the service returned a value for the UnsuccessfulFaceDeletions property.
List<SdkField<?>>	sdkFields()
static Class<? extends DeleteFacesResponse.Builder>	serializableBuilderClass()
DeleteFacesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UnsuccessfulFaceDeletion>	unsuccessfulFaceDeletions()	An array of any faces that weren't deleted.

Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse

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

hasDeletedFaces

public final boolean hasDeletedFaces()

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

deletedFaces

public final List<String> deletedFaces()

An array of strings (face IDs) of the faces that were deleted.

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

Returns:

An array of strings (face IDs) of the faces that were deleted.

hasUnsuccessfulFaceDeletions

public final boolean hasUnsuccessfulFaceDeletions()

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

unsuccessfulFaceDeletions

public final List<UnsuccessfulFaceDeletion> unsuccessfulFaceDeletions()

An array of any faces that weren't deleted.

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

Returns:

An array of any faces that weren't deleted.

toBuilder

public DeleteFacesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DeleteFacesResponse.Builder,DeleteFacesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DeleteFacesResponse.Builder builder()

serializableBuilderClass

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