Interface StartSegmentDetectionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>, RekognitionRequest.Builder, SdkBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartSegmentDetectionRequest
@Mutable @NotThreadSafe public static interface StartSegmentDetectionRequest.Builder extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>

  • Method Details

    • video

      StartSegmentDetectionRequest.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 StartSegmentDetectionRequest.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:

    • clientRequestToken

      StartSegmentDetectionRequest.Builder clientRequestToken(String clientRequestToken)

      Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

      Parameters:
      clientRequestToken - Idempotent token used to identify the start request. If you use the same token with multiple StartSegmentDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      StartSegmentDetectionRequest.Builder notificationChannel(NotificationChannel notificationChannel)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

      Parameters:
      notificationChannel - The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • notificationChannel

      default StartSegmentDetectionRequest.Builder notificationChannel(Consumer<NotificationChannel.Builder> notificationChannel)

      The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the segment detection operation. Note that the Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

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

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

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

    • jobTag

      StartSegmentDetectionRequest.Builder jobTag(String jobTag)

      An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.

      Parameters:
      jobTag - An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use JobTag to group related jobs and identify them in the completion notification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      StartSegmentDetectionRequest.Builder filters(StartSegmentDetectionFilters filters)

      Filters for technical cue or shot detection.

      Parameters:
      filters - Filters for technical cue or shot detection.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default StartSegmentDetectionRequest.Builder filters(Consumer<StartSegmentDetectionFilters.Builder> filters)

      Filters for technical cue or shot detection.

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

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

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

    • segmentTypesWithStrings

      StartSegmentDetectionRequest.Builder segmentTypesWithStrings(Collection<String> segmentTypes)

      An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentTypesWithStrings

      StartSegmentDetectionRequest.Builder segmentTypesWithStrings(String... segmentTypes)

      An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentTypes

      StartSegmentDetectionRequest.Builder segmentTypes(Collection<SegmentType> segmentTypes)

      An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentTypes

      StartSegmentDetectionRequest.Builder segmentTypes(SegmentType... segmentTypes)

      An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.

      Parameters:
      segmentTypes - An array of segment types to detect in the video. Valid values are TECHNICAL_CUE and SHOT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartSegmentDetectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSegmentDetectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.