Package software.amazon.awssdk.services.rekognition.model

Interface GetFaceSearchResponse.Builder

    • Method Detail

      • jobStatus

        GetFaceSearchResponse.Builder jobStatus​(String 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:
        VideoJobStatus, VideoJobStatus

      • statusMessage

        GetFaceSearchResponse.Builder statusMessage​(String 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

        GetFaceSearchResponse.Builder nextToken​(String 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

        GetFaceSearchResponse.Builder videoMetadata​(VideoMetadata 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.

      • persons

        GetFaceSearchResponse.Builder persons​(Collection<PersonMatch> 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. Each Persons 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 to StartFaceSearch. Each Persons 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

        GetFaceSearchResponse.Builder persons​(PersonMatch... 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. Each Persons 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 to StartFaceSearch. Each Persons 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

        GetFaceSearchResponse.Builder 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. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons 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.

        This is a convenience method that creates an instance of the PersonMatch.Builder avoiding the need to create one manually via PersonMatch.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #persons(List).

        Parameters:
        persons - a consumer that will call methods on PersonMatch.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #persons(java.util.Collection)

      • jobId

        GetFaceSearchResponse.Builder jobId​(String 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

        GetFaceSearchResponse.Builder video​(Video 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.

      • jobTag

        GetFaceSearchResponse.Builder jobTag​(String 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.