Interface GetFaceDetectionResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder,Buildable,CopyableBuilder<GetFaceDetectionResponse.Builder,GetFaceDetectionResponse>,RekognitionResponse.Builder,SdkBuilder<GetFaceDetectionResponse.Builder,GetFaceDetectionResponse>,SdkPojo,SdkResponse.Builder
- Enclosing class:
- GetFaceDetectionResponse
public static interface GetFaceDetectionResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetFaceDetectionResponse.Builder,GetFaceDetectionResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GetFaceDetectionResponse.Builderfaces(Collection<FaceDetection> faces)An array of faces detected in the video.GetFaceDetectionResponse.Builderfaces(Consumer<FaceDetection.Builder>... faces)An array of faces detected in the video.GetFaceDetectionResponse.Builderfaces(FaceDetection... faces)An array of faces detected in the video.GetFaceDetectionResponse.BuilderjobId(String jobId)Job identifier for the face detection operation for which you want to obtain results.GetFaceDetectionResponse.BuilderjobStatus(String jobStatus)The current status of the face detection job.GetFaceDetectionResponse.BuilderjobStatus(VideoJobStatus jobStatus)The current status of the face detection job.GetFaceDetectionResponse.BuilderjobTag(String jobTag)A job identifier specified in the call to StartFaceDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.GetFaceDetectionResponse.BuildernextToken(String nextToken)If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.GetFaceDetectionResponse.BuilderstatusMessage(String statusMessage)If the job fails,StatusMessageprovides a descriptive error message.default GetFaceDetectionResponse.Buildervideo(Consumer<Video.Builder> video)Sets the value of the Video property for this object.GetFaceDetectionResponse.Buildervideo(Video video)Sets the value of the Video property for this object.default GetFaceDetectionResponse.BuildervideoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)Information about a video that Amazon Rekognition Video analyzed.GetFaceDetectionResponse.BuildervideoMetadata(VideoMetadata videoMetadata)Information about a video that Amazon Rekognition Video 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, sdkFieldNameToField, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
jobStatus
GetFaceDetectionResponse.Builder jobStatus(String jobStatus)
The current status of the face detection job.
- Parameters:
jobStatus- The current status of the face detection job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VideoJobStatus,VideoJobStatus
-
jobStatus
GetFaceDetectionResponse.Builder jobStatus(VideoJobStatus jobStatus)
The current status of the face detection job.
- Parameters:
jobStatus- The current status of the face detection job.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
VideoJobStatus,VideoJobStatus
-
statusMessage
GetFaceDetectionResponse.Builder statusMessage(String statusMessage)
If the job fails,
StatusMessageprovides a descriptive error message.- Parameters:
statusMessage- If the job fails,StatusMessageprovides a descriptive error message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
videoMetadata
GetFaceDetectionResponse.Builder videoMetadata(VideoMetadata videoMetadata)
Information about a video that Amazon Rekognition Video analyzed.
Videometadatais returned in every page of paginated responses from a Amazon Rekognition video operation.- Parameters:
videoMetadata- Information about a video that Amazon Rekognition Video analyzed.Videometadatais 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
default GetFaceDetectionResponse.Builder videoMetadata(Consumer<VideoMetadata.Builder> videoMetadata)
Information about a video that Amazon Rekognition Video analyzed.
This is a convenience method that creates an instance of theVideometadatais returned in every page of paginated responses from a Amazon Rekognition video operation.VideoMetadata.Builderavoiding the need to create one manually viaVideoMetadata.builder().When the
Consumercompletes,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:
videoMetadata(VideoMetadata)
-
nextToken
GetFaceDetectionResponse.Builder nextToken(String nextToken)
If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.
- Parameters:
nextToken- If the response is truncated, Amazon Rekognition returns this token that you can use in the subsequent request to retrieve the next set of faces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
faces
GetFaceDetectionResponse.Builder faces(Collection<FaceDetection> faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
- Parameters:
faces- An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
faces
GetFaceDetectionResponse.Builder faces(FaceDetection... faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
- Parameters:
faces- An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
faces
GetFaceDetectionResponse.Builder faces(Consumer<FaceDetection.Builder>... faces)
An array of faces detected in the video. Each element contains a detected face's details and the time, in milliseconds from the start of the video, the face was detected.
This is a convenience method that creates an instance of theFaceDetection.Builderavoiding the need to create one manually viaFaceDetection.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#faces(List.) - Parameters:
faces- a consumer that will call methods onFaceDetection.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#faces(java.util.Collection)
-
jobId
GetFaceDetectionResponse.Builder jobId(String jobId)
Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.
- Parameters:
jobId- Job identifier for the face detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceDetection.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
video
GetFaceDetectionResponse.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.
-
video
default GetFaceDetectionResponse.Builder video(Consumer<Video.Builder> video)
Sets the value of the Video property for this object. This is a convenience method that creates an instance of theVideo.Builderavoiding the need to create one manually viaVideo.builder().When the
Consumercompletes,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:
video(Video)
-
jobTag
GetFaceDetectionResponse.Builder jobTag(String jobTag)
A job identifier specified in the call to StartFaceDetection 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 StartFaceDetection 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.
-
-