software.amazon.awssdk.services.rekognition.model

Class StartLabelDetectionRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartLabelDetectionRequest.Builder,StartLabelDetectionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartLabelDetectionRequest
extends RekognitionRequest
implements ToCopyableBuilder<StartLabelDetectionRequest.Builder,StartLabelDetectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartLabelDetectionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartLabelDetectionRequest.Builder	builder()
String	clientRequestToken() Idempotent token used to identify the start request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<LabelDetectionFeatureName>	features() The features to return after video analysis.
List<String>	featuresAsStrings() The features to return after video analysis.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFeatures() For responses, this returns true if the service returned a value for the Features property.
int	hashCode()
String	jobTag() An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.
Float	minConfidence() Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label.
NotificationChannel	notificationChannel() The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.
List<SdkField<?>>	sdkFields()
static Class<? extends StartLabelDetectionRequest.Builder>	serializableBuilderClass()
LabelDetectionSettings	settings() The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation.
StartLabelDetectionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Video	video() The video in which you want to detect labels.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

video

public final Video video()

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

Returns:

The video in which you want to detect labels. 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 StartLabelDetection 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 StartLabelDetection requests, the same JobId is returned. Use ClientRequestToken to prevent the same job from being accidently started more than once.

minConfidence

public final Float minConfidence()

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.

Returns:

Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.

If you don't specify MinConfidence, the operation returns labels and bounding boxes (if detected) with confidence values greater than or equal to 50 percent.

notificationChannel

public final NotificationChannel notificationChannel()

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

Returns:

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

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.

features

public final List<LabelDetectionFeatureName> features()

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

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 hasFeatures() method.

Returns:

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

hasFeatures

public final boolean hasFeatures()

For responses, this returns true if the service returned a value for the Features 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.

featuresAsStrings

public final List<String> featuresAsStrings()

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

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 hasFeatures() method.

Returns:

The features to return after video analysis. You can specify that GENERAL_LABELS are returned.

settings

public final LabelDetectionSettings settings()

The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.

Returns:

The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation. Settings can include filters for GENERAL_LABELS.

toBuilder

public StartLabelDetectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartLabelDetectionRequest.Builder,StartLabelDetectionRequest>

Specified by:

toBuilder in class RekognitionRequest

builder

public static StartLabelDetectionRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo