com.amazonaws.services.rekognition.model

Class CreateCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.rekognition.model.CreateCollectionRequest

All Implemented Interfaces:

Serializable, Cloneable

public class CreateCollectionRequest
extends AmazonWebServiceRequest
implements Serializable

Creates a collection in an AWS Region. You can add faces to the collection using the operation.

For example, you might create collections, one for each of your application users. A user can then index faces using the IndexFaces operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container.

Collection names are case-sensitive.

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreateCollectionRequest() Default constructor for CreateCollectionRequest object.
CreateCollectionRequest(String collectionId) Constructs a new CreateCollectionRequest object.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getCollectionId() ID for the collection that you are creating.
int	hashCode()
void	setCollectionId(String collectionId) ID for the collection that you are creating.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateCollectionRequest	withCollectionId(String collectionId) ID for the collection that you are creating.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateCollectionRequest

public CreateCollectionRequest()

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

CreateCollectionRequest

public CreateCollectionRequest(String collectionId)

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

Parameters:

collectionId -

ID for the collection that you are creating.

Method Detail

getCollectionId

public String getCollectionId()

ID for the collection that you are creating.

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

Returns:

ID for the collection that you are creating.

setCollectionId

public void setCollectionId(String collectionId)

ID for the collection that you are creating.

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

Parameters:

collectionId -

ID for the collection that you are creating.

withCollectionId

public CreateCollectionRequest withCollectionId(String collectionId)

ID for the collection that you are creating.

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 -

ID for the collection that you are creating.

Returns:

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

toString

public String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object