Interface GetFaceSearchResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetFaceSearchResponse.Builder,
,GetFaceSearchResponse> RekognitionResponse.Builder
,SdkBuilder<GetFaceSearchResponse.Builder,
,GetFaceSearchResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetFaceSearchResponse
-
Method Summary
Modifier and TypeMethodDescriptionJob identifier for the face search operation for which you want to obtain results.The current status of the face search job.jobStatus
(VideoJobStatus jobStatus) The current status of the face search job.A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.persons
(Collection<PersonMatch> persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.persons
(Consumer<PersonMatch.Builder>... persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.persons
(PersonMatch... persons) An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection.statusMessage
(String statusMessage) If the job fails,StatusMessage
provides a descriptive error message.default GetFaceSearchResponse.Builder
video
(Consumer<Video.Builder> video) Sets the value of the Video property for this object.Sets the value of the Video property for this object.default GetFaceSearchResponse.Builder
videoMetadata
(Consumer<VideoMetadata.Builder> videoMetadata) Information about a video that Amazon Rekognition analyzed.videoMetadata
(VideoMetadata videoMetadata) Information about a video that Amazon Rekognition analyzed.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
jobStatus
The current status of the face search job.
- Parameters:
jobStatus
- The current status of the face search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobStatus
The current status of the face search job.
- Parameters:
jobStatus
- The current status of the face search job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statusMessage
If the job fails,
StatusMessage
provides a descriptive error message.- Parameters:
statusMessage
- If the job fails,StatusMessage
provides a descriptive error message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.
- Parameters:
nextToken
- If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoMetadata
Information about a video that Amazon Rekognition analyzed.
Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.- Parameters:
videoMetadata
- Information about a video that Amazon Rekognition analyzed.Videometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoMetadata
Information about a video that Amazon Rekognition analyzed.
This is a convenience method that creates an instance of theVideometadata
is returned in every page of paginated responses from a Amazon Rekognition Video operation.VideoMetadata.Builder
avoiding the need to create one manually viaVideoMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovideoMetadata(VideoMetadata)
.- Parameters:
videoMetadata
- a consumer that will call methods onVideoMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
persons
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to
StartFaceSearch
. EachPersons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.- Parameters:
persons
- An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call toStartFaceSearch
. EachPersons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
persons
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to
StartFaceSearch
. EachPersons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.- Parameters:
persons
- An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call toStartFaceSearch
. EachPersons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
persons
An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to
This is a convenience method that creates an instance of theStartFaceSearch
. EachPersons
element includes a time the person was matched, face match details (FaceMatches
) for matching faces in the collection, and person information (Person
) for the matched person.PersonMatch.Builder
avoiding the need to create one manually viaPersonMatch.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topersons(List<PersonMatch>)
.- Parameters:
persons
- a consumer that will call methods onPersonMatch.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobId
Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.
- Parameters:
jobId
- Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
video
Sets the value of the Video property for this object.- Parameters:
video
- The new value for the Video property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
video
Sets the value of the Video property for this object. This is a convenience method that creates an instance of theVideo.Builder
avoiding the need to create one manually viaVideo.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovideo(Video)
.- Parameters:
video
- a consumer that will call methods onVideo.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
jobTag
A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
- Parameters:
jobTag
- A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-