Class StartLabelDetectionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartLabelDetectionRequest.Builder,
StartLabelDetectionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Idempotent token used to identify the start request.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<LabelDetectionFeatureName> features()
The features to return after video analysis.The features to return after video analysis.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the Features property.final int
hashCode()
final String
jobTag()
An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic.final Float
Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label.final NotificationChannel
The Amazon SNS topic ARN you want Amazon Rekognition Video to publish the completion status of the label detection operation to.static Class
<? extends StartLabelDetectionRequest.Builder> final LabelDetectionSettings
settings()
The settings for a StartLabelDetection request.Contains the specified parameters for the label detection request of an asynchronous label analysis operation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Video
video()
The video in which you want to detect labels.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Idempotent token used to identify the start request. If you use the same token with multiple
StartLabelDetection
requests, the sameJobId
is returned. UseClientRequestToken
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 sameJobId
is returned. UseClientRequestToken
to prevent the same job from being accidently started more than once.
-
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
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
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
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 theisEmpty()
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
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
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
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 interfaceToCopyableBuilder<StartLabelDetectionRequest.Builder,
StartLabelDetectionRequest> - Specified by:
toBuilder
in classRekognitionRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-