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

Class AssociateFacesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociateFacesResponse.Builder,AssociateFacesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociateFacesResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<AssociatedFace>	associatedFaces()	An array of AssociatedFace objects containing FaceIDs that have been successfully associated with the UserID.
static AssociateFacesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssociatedFaces()	For responses, this returns true if the service returned a value for the AssociatedFaces property.
int	hashCode()
boolean	hasUnsuccessfulFaceAssociations()	For responses, this returns true if the service returned a value for the UnsuccessfulFaceAssociations property.
List<SdkField<?>>	sdkFields()
static Class<? extends AssociateFacesResponse.Builder>	serializableBuilderClass()
AssociateFacesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<UnsuccessfulFaceAssociation>	unsuccessfulFaceAssociations()	An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully associated along with the reasons.
UserStatus	userStatus()	The status of an update made to a UserID.
String	userStatusAsString()	The status of an update made to a UserID.

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

hasAssociatedFaces

public final boolean hasAssociatedFaces()

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

associatedFaces

public final List<AssociatedFace> associatedFaces()

An array of AssociatedFace objects containing FaceIDs that have been successfully associated with the UserID. Returned if the AssociateFaces action is successful.

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

Returns:

An array of AssociatedFace objects containing FaceIDs that have been successfully associated with the UserID. Returned if the AssociateFaces action is successful.

hasUnsuccessfulFaceAssociations

public final boolean hasUnsuccessfulFaceAssociations()

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

unsuccessfulFaceAssociations

public final List<UnsuccessfulFaceAssociation> unsuccessfulFaceAssociations()

An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully associated along with the reasons. Returned if the AssociateFaces action is successful.

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

Returns:

An array of UnsuccessfulAssociation objects containing FaceIDs that are not successfully associated along with the reasons. Returned if the AssociateFaces action is successful.

userStatus

public final UserStatus userStatus()

The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.

If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().

Returns:

The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.

See Also:

UserStatus

userStatusAsString

public final String userStatusAsString()

The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.

If the service returns an enum value that is not available in the current SDK version, userStatus will return UserStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().

Returns:

The status of an update made to a UserID. Reflects if the UserID has been updated for every requested change.

See Also:

UserStatus

toBuilder

public AssociateFacesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociateFacesResponse.Builder,AssociateFacesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static AssociateFacesResponse.Builder builder()

serializableBuilderClass

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