Class StartFaceDetectionRequest

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.StartFaceDetectionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartFaceDetectionRequest extends RekognitionRequest implements ToCopyableBuilder<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>

  • Method Details

    • video

      public final Video video()

      The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

      Returns:
      The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.

    • clientRequestToken

      public final String clientRequestToken()

      Idempotent token used to identify the start request. If you use the same token with multiple StartFaceDetection 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 StartFaceDetection 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 face detection operation. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy.

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

    • faceAttributes

      public final FaceAttributes faceAttributes()

      The face attributes you want returned.

      DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

      ALL - All facial attributes are returned.

      If the service returns an enum value that is not available in the current SDK version, faceAttributes will return FaceAttributes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from faceAttributesAsString().

      Returns:
      The face attributes you want returned.

      DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

      ALL - All facial attributes are returned.

      See Also:

    • faceAttributesAsString

      public final String faceAttributesAsString()

      The face attributes you want returned.

      DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

      ALL - All facial attributes are returned.

      If the service returns an enum value that is not available in the current SDK version, faceAttributes will return FaceAttributes.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from faceAttributesAsString().

      Returns:
      The face attributes you want returned.

      DEFAULT - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks.

      ALL - All facial attributes are returned.

      See Also:

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

    • toBuilder

      public StartFaceDetectionRequest.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<StartFaceDetectionRequest.Builder,StartFaceDetectionRequest>
      Specified by:
      toBuilder in class RekognitionRequest
      Returns:
      a builder for type T

    • builder

      public static StartFaceDetectionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartFaceDetectionRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.