/*
* Copyright 2010-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.rekognition.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
* <p>
* Deletes faces from a collection. You specify a collection ID and an array of
* face IDs to remove from the collection.
* </p>
* <p>
* This operation requires permissions to perform the
* <code>rekognition:DeleteFaces</code> action.
* </p>
*/
public class DeleteFacesRequest extends AmazonWebServiceRequest implements Serializable {
/**
* <p>
* Collection from which to remove the specific faces.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.\-]+<br/>
*/
private String collectionId;
/**
* <p>
* An array of face IDs to delete.
* </p>
*/
private java.util.List<String> faceIds;
/**
* <p>
* Collection from which to remove the specific faces.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.\-]+<br/>
*
* @return <p>
* Collection from which to remove the specific faces.
* </p>
*/
public String getCollectionId() {
return collectionId;
}
/**
* <p>
* Collection from which to remove the specific faces.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.\-]+<br/>
*
* @param collectionId <p>
* Collection from which to remove the specific faces.
* </p>
*/
public void setCollectionId(String collectionId) {
this.collectionId = collectionId;
}
/**
* <p>
* Collection from which to remove the specific faces.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 255<br/>
* <b>Pattern: </b>[a-zA-Z0-9_.\-]+<br/>
*
* @param collectionId <p>
* Collection from which to remove the specific faces.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public DeleteFacesRequest withCollectionId(String collectionId) {
this.collectionId = collectionId;
return this;
}
/**
* <p>
* An array of face IDs to delete.
* </p>
*
* @return <p>
* An array of face IDs to delete.
* </p>
*/
public java.util.List<String> getFaceIds() {
return faceIds;
}
/**
* <p>
* An array of face IDs to delete.
* </p>
*
* @param faceIds <p>
* An array of face IDs to delete.
* </p>
*/
public void setFaceIds(java.util.Collection<String> faceIds) {
if (faceIds == null) {
this.faceIds = null;
return;
}
this.faceIds = new java.util.ArrayList<String>(faceIds);
}
/**
* <p>
* An array of face IDs to delete.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param faceIds <p>
* An array of face IDs to delete.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public DeleteFacesRequest withFaceIds(String... faceIds) {
if (getFaceIds() == null) {
this.faceIds = new java.util.ArrayList<String>(faceIds.length);
}
for (String value : faceIds) {
this.faceIds.add(value);
}
return this;
}
/**
* <p>
* An array of face IDs to delete.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param faceIds <p>
* An array of face IDs to delete.
* </p>
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public DeleteFacesRequest withFaceIds(java.util.Collection<String> faceIds) {
setFaceIds(faceIds);
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getCollectionId() != null)
sb.append("CollectionId: " + getCollectionId() + ",");
if (getFaceIds() != null)
sb.append("FaceIds: " + getFaceIds());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode
+ ((getCollectionId() == null) ? 0 : getCollectionId().hashCode());
hashCode = prime * hashCode + ((getFaceIds() == null) ? 0 : getFaceIds().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DeleteFacesRequest == false)
return false;
DeleteFacesRequest other = (DeleteFacesRequest) obj;
if (other.getCollectionId() == null ^ this.getCollectionId() == null)
return false;
if (other.getCollectionId() != null
&& other.getCollectionId().equals(this.getCollectionId()) == false)
return false;
if (other.getFaceIds() == null ^ this.getFaceIds() == null)
return false;
if (other.getFaceIds() != null && other.getFaceIds().equals(this.getFaceIds()) == false)
return false;
return true;
}
}