com.amazonaws.services.rekognition.model

Class DeleteFacesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.DeleteFacesRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DeleteFacesRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

This operation requires permissions to perform the rekognition:DeleteFaces action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeleteFacesRequest() Default constructor for DeleteFacesRequest object.
DeleteFacesRequest(java.lang.String collectionId, java.util.List<java.lang.String> faceIds) Constructs a new DeleteFacesRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCollectionId() Collection from which to remove the specific faces.
java.util.List<java.lang.String>	getFaceIds() An array of face IDs to delete.
int	hashCode()
void	setCollectionId(java.lang.String collectionId) Collection from which to remove the specific faces.
void	setFaceIds(java.util.Collection<java.lang.String> faceIds) An array of face IDs to delete.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DeleteFacesRequest	withCollectionId(java.lang.String collectionId) Collection from which to remove the specific faces.
DeleteFacesRequest	withFaceIds(java.util.Collection<java.lang.String> faceIds) An array of face IDs to delete.
DeleteFacesRequest	withFaceIds(java.lang.String... faceIds) An array of face IDs to delete.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeleteFacesRequest

public DeleteFacesRequest()

Default constructor for DeleteFacesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

DeleteFacesRequest

public DeleteFacesRequest(java.lang.String collectionId,
                          java.util.List<java.lang.String> faceIds)

Constructs a new DeleteFacesRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

collectionId -

Collection from which to remove the specific faces.

faceIds -

An array of face IDs to delete.

Method Detail

getCollectionId

public java.lang.String getCollectionId()

Collection from which to remove the specific faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Returns:

Collection from which to remove the specific faces.

setCollectionId

public void setCollectionId(java.lang.String collectionId)

Collection from which to remove the specific faces.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

Collection from which to remove the specific faces.

withCollectionId

public DeleteFacesRequest withCollectionId(java.lang.String collectionId)

Collection from which to remove the specific faces.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 255
Pattern: [a-zA-Z0-9_.\-]+

Parameters:

collectionId -

Collection from which to remove the specific faces.

Returns:

A reference to this updated object so that method calls can be chained together.

getFaceIds

public java.util.List<java.lang.String> getFaceIds()

An array of face IDs to delete.

Returns:

An array of face IDs to delete.

setFaceIds

public void setFaceIds(java.util.Collection<java.lang.String> faceIds)

An array of face IDs to delete.

Parameters:

faceIds -

An array of face IDs to delete.

withFaceIds

public DeleteFacesRequest withFaceIds(java.lang.String... faceIds)

An array of face IDs to delete.

Returns a reference to this object so that method calls can be chained together.

Parameters:

faceIds -

An array of face IDs to delete.

Returns:

A reference to this updated object so that method calls can be chained together.

withFaceIds

public DeleteFacesRequest withFaceIds(java.util.Collection<java.lang.String> faceIds)

An array of face IDs to delete.

Returns a reference to this object so that method calls can be chained together.

Parameters:

faceIds -

An array of face IDs to delete.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object