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

Interface GetSegmentDetectionResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>, RekognitionResponse.Builder, SdkBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetSegmentDetectionResponse
public static interface GetSegmentDetectionResponse.Builder extends RekognitionResponse.Builder, SdkPojo, CopyableBuilder<GetSegmentDetectionResponse.Builder,GetSegmentDetectionResponse>

  • Method Details

    • jobStatus

      GetSegmentDetectionResponse.Builder jobStatus(String jobStatus)

      Current status of the segment detection job.

      Parameters:
      jobStatus - Current status of the segment detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobStatus

      GetSegmentDetectionResponse.Builder jobStatus(VideoJobStatus jobStatus)

      Current status of the segment detection job.

      Parameters:
      jobStatus - Current status of the segment detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusMessage

      GetSegmentDetectionResponse.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.

    • videoMetadata

      GetSegmentDetectionResponse.Builder videoMetadata(Collection<VideoMetadata> videoMetadata)

      Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

      Parameters:
      videoMetadata - Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • videoMetadata

      GetSegmentDetectionResponse.Builder videoMetadata(VideoMetadata... videoMetadata)

      Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

      Parameters:
      videoMetadata - Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • videoMetadata

      GetSegmentDetectionResponse.Builder videoMetadata(Consumer<VideoMetadata.Builder>... videoMetadata)

      Currently, Amazon Rekognition Video returns a single object in the VideoMetadata array. The object contains information about the video stream in the input file that Amazon Rekognition Video chose to analyze. The VideoMetadata object includes the video codec, video format and other information. Video metadata is returned in each page of information returned by GetSegmentDetection.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to videoMetadata(List<VideoMetadata>).

      Parameters:
      videoMetadata - a consumer that will call methods on VideoMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • audioMetadata

      GetSegmentDetectionResponse.Builder audioMetadata(Collection<AudioMetadata> audioMetadata)

      An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

      Parameters:
      audioMetadata - An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audioMetadata

      GetSegmentDetectionResponse.Builder audioMetadata(AudioMetadata... audioMetadata)

      An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

      Parameters:
      audioMetadata - An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • audioMetadata

      GetSegmentDetectionResponse.Builder audioMetadata(Consumer<AudioMetadata.Builder>... audioMetadata)

      An array of objects. There can be multiple audio streams. Each AudioMetadata object contains metadata for a single audio stream. Audio information in an AudioMetadata objects includes the audio codec, the number of audio channels, the duration of the audio stream, and the sample rate. Audio metadata is returned in each page of information returned by GetSegmentDetection.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to audioMetadata(List<AudioMetadata>).

      Parameters:
      audioMetadata - a consumer that will call methods on AudioMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      GetSegmentDetectionResponse.Builder nextToken(String nextToken)

      If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.

      Parameters:
      nextToken - If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of text.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segments

      GetSegmentDetectionResponse.Builder segments(Collection<SegmentDetection> segments)

      An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

      Parameters:
      segments - An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection . Within each segment type the array is sorted by timestamp values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segments

      GetSegmentDetectionResponse.Builder segments(SegmentDetection... segments)

      An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

      Parameters:
      segments - An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection . Within each segment type the array is sorted by timestamp values.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segments

      GetSegmentDetectionResponse.Builder segments(Consumer<SegmentDetection.Builder>... segments)

      An array of segments detected in a video. The array is sorted by the segment types (TECHNICAL_CUE or SHOT) specified in the SegmentTypes input parameter of StartSegmentDetection. Within each segment type the array is sorted by timestamp values.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to segments(List<SegmentDetection>).

      Parameters:
      segments - a consumer that will call methods on SegmentDetection.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedSegmentTypes

      GetSegmentDetectionResponse.Builder selectedSegmentTypes(Collection<SegmentTypeInfo> selectedSegmentTypes)

      An array containing the segment types requested in the call to StartSegmentDetection.

      Parameters:
      selectedSegmentTypes - An array containing the segment types requested in the call to StartSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedSegmentTypes

      GetSegmentDetectionResponse.Builder selectedSegmentTypes(SegmentTypeInfo... selectedSegmentTypes)

      An array containing the segment types requested in the call to StartSegmentDetection.

      Parameters:
      selectedSegmentTypes - An array containing the segment types requested in the call to StartSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedSegmentTypes

      GetSegmentDetectionResponse.Builder selectedSegmentTypes(Consumer<SegmentTypeInfo.Builder>... selectedSegmentTypes)

      An array containing the segment types requested in the call to StartSegmentDetection.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to selectedSegmentTypes(List<SegmentTypeInfo>).

      Parameters:
      selectedSegmentTypes - a consumer that will call methods on SegmentTypeInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobId

      GetSegmentDetectionResponse.Builder jobId(String jobId)

      Job identifier for the segment detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartSegmentDetection.

      Parameters:
      jobId - Job identifier for the segment detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartSegmentDetection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • video

      GetSegmentDetectionResponse.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 GetSegmentDetectionResponse.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 the Video.Builder avoiding the need to create one manually via Video.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to video(Video).

      Parameters:
      video - a consumer that will call methods on Video.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobTag

      GetSegmentDetectionResponse.Builder jobTag(String jobTag)

      A job identifier specified in the call to StartSegmentDetection 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 StartSegmentDetection 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.