Class ListFacesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListFacesRequest.Builder,
ListFacesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListFacesRequest.Builder
builder()
final String
ID of the collection from which to list the faces.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.faceIds()
An array of face IDs to filter results with when listing faces in a collection.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the FaceIds property.final int
hashCode()
final Integer
Maximum number of faces to return.final String
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.static Class
<? extends ListFacesRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
userId()
An array of user IDs to filter results with when listing faces in a collection.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
collectionId
ID of the collection from which to list the faces.
- Returns:
- ID of the collection from which to list the faces.
-
nextToken
If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
- Returns:
- If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.
-
maxResults
Maximum number of faces to return.
- Returns:
- Maximum number of faces to return.
-
userId
An array of user IDs to filter results with when listing faces in a collection.
- Returns:
- An array of user IDs to filter results with when listing faces in a collection.
-
hasFaceIds
public final boolean hasFaceIds()For responses, this returns true if the service returned a value for the FaceIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
faceIds
An array of face IDs to filter results with when listing faces in a collection.
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
hasFaceIds()
method.- Returns:
- An array of face IDs to filter results with when listing faces in a collection.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListFacesRequest.Builder,
ListFacesRequest> - Specified by:
toBuilder
in classRekognitionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-