Class StartSegmentDetectionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.rekognition.model.RekognitionRequest
software.amazon.awssdk.services.rekognition.model.StartSegmentDetectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartSegmentDetectionRequest extends RekognitionRequest implements ToCopyableBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>

  • Method Details

    • video

      public final Video video()
      Returns the value of the Video property for this object.
      Returns:
      The value of the Video property for this object.

    • clientRequestToken

      public final 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.

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

    • notificationChannel

      public final 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.

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

    • jobTag

      public final 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.

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

    • filters

      public final StartSegmentDetectionFilters filters()

      Filters for technical cue or shot detection.

      Returns:
      Filters for technical cue or shot detection.

    • segmentTypes

      public final List<SegmentType> segmentTypes()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegmentTypes() method.

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

    • hasSegmentTypes

      public final boolean hasSegmentTypes()
      For responses, this returns true if the service returned a value for the SegmentTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • segmentTypesAsStrings

      public final List<String> segmentTypesAsStrings()

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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSegmentTypes() method.

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

    • toBuilder

      public StartSegmentDetectionRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartSegmentDetectionRequest.Builder,StartSegmentDetectionRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static StartSegmentDetectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartSegmentDetectionRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.