Class GetLabelDetectionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetLabelDetectionResponse.Builder,
GetLabelDetectionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Information about the paramters used when getting a response.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Labels property.final String
jobId()
Job identifier for the label detection operation for which you want to obtain results.final VideoJobStatus
The current status of the label detection job.final String
The current status of the label detection job.final String
jobTag()
A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.final String
Version number of the label detection model that was used to detect labels.final List
<LabelDetection> labels()
An array of labels detected in the video.final String
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.static Class
<? extends GetLabelDetectionResponse.Builder> final String
If the job fails,StatusMessage
provides a descriptive error message.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()
Returns the value of the Video property for this object.final VideoMetadata
Information about a video that Amazon Rekognition Video analyzed.Methods inherited from class software.amazon.awssdk.services.rekognition.model.RekognitionResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobStatus
The current status of the label detection job.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnVideoJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the label detection job.
- See Also:
-
jobStatusAsString
The current status of the label detection job.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnVideoJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the label detection job.
- See Also:
-
statusMessage
If the job fails,
StatusMessage
provides a descriptive error message.- Returns:
- If the job fails,
StatusMessage
provides a descriptive error message.
-
videoMetadata
Information about a video that Amazon Rekognition Video analyzed.
Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.- Returns:
- Information about a video that Amazon Rekognition Video analyzed.
Videometadata
is returned in every page of paginated responses from a Amazon Rekognition video operation.
-
nextToken
If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
- Returns:
- If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of labels.
-
hasLabels
public final boolean hasLabels()For responses, this returns true if the service returned a value for the Labels 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. -
labels
An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
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
hasLabels()
method.- Returns:
- An array of labels detected in the video. Each element contains the detected label and the time, in milliseconds from the start of the video, that the label was detected.
-
labelModelVersion
Version number of the label detection model that was used to detect labels.
- Returns:
- Version number of the label detection model that was used to detect labels.
-
jobId
Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.
- Returns:
- Job identifier for the label detection operation for which you want to obtain results. The job identifer is returned by an initial call to StartLabelDetection.
-
video
Returns the value of the Video property for this object.- Returns:
- The value of the Video property for this object.
-
jobTag
A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
- Returns:
- A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
-
getRequestMetadata
Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
- Returns:
- Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
-
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<GetLabelDetectionResponse.Builder,
GetLabelDetectionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-