GetLabelDetectionResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.rekognition.model.GetLabelDetectionResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetLabelDetectionResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetLabelDetectionResult()

Constructors
Constructor and Description
`GetLabelDetectionResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetLabelDetectionResult`	`clone()`
`boolean`	`equals(Object obj)`
`GetLabelDetectionRequestMetadata`	`getGetRequestMetadata()` Information about the paramters used when getting a response.
`String`	`getJobId()` Job identifier for the label detection operation for which you want to obtain results.
`String`	`getJobStatus()` The current status of the label detection job.
`String`	`getJobTag()` A job identifier specified in the call to StartLabelDetection and returned in the job completion notification sent to your Amazon Simple Notification Service topic.
`String`	`getLabelModelVersion()` Version number of the label detection model that was used to detect labels.
`List<LabelDetection>`	`getLabels()` An array of labels detected in the video.
`String`	`getNextToken()` 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.
`String`	`getStatusMessage()` If the job fails, `StatusMessage` provides a descriptive error message.
`Video`	`getVideo()`
`VideoMetadata`	`getVideoMetadata()` Information about a video that Amazon Rekognition Video analyzed.
`int`	`hashCode()`
`void`	`setGetRequestMetadata(GetLabelDetectionRequestMetadata getRequestMetadata)` Information about the paramters used when getting a response.
`void`	`setJobId(String jobId)` Job identifier for the label detection operation for which you want to obtain results.
`void`	`setJobStatus(String jobStatus)` The current status of the label detection job.
`void`	`setJobTag(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.
`void`	`setLabelModelVersion(String labelModelVersion)` Version number of the label detection model that was used to detect labels.
`void`	`setLabels(Collection<LabelDetection> labels)` An array of labels detected in the video.
`void`	`setNextToken(String 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.
`void`	`setStatusMessage(String statusMessage)` If the job fails, `StatusMessage` provides a descriptive error message.
`void`	`setVideo(Video video)`
`void`	`setVideoMetadata(VideoMetadata videoMetadata)` Information about a video that Amazon Rekognition Video analyzed.
`String`	`toString()` Returns a string representation of this object.
`GetLabelDetectionResult`	`withGetRequestMetadata(GetLabelDetectionRequestMetadata getRequestMetadata)` Information about the paramters used when getting a response.
`GetLabelDetectionResult`	`withJobId(String jobId)` Job identifier for the label detection operation for which you want to obtain results.
`GetLabelDetectionResult`	`withJobStatus(String jobStatus)` The current status of the label detection job.
`GetLabelDetectionResult`	`withJobStatus(VideoJobStatus jobStatus)` The current status of the label detection job.
`GetLabelDetectionResult`	`withJobTag(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.
`GetLabelDetectionResult`	`withLabelModelVersion(String labelModelVersion)` Version number of the label detection model that was used to detect labels.
`GetLabelDetectionResult`	`withLabels(Collection<LabelDetection> labels)` An array of labels detected in the video.
`GetLabelDetectionResult`	`withLabels(LabelDetection... labels)` An array of labels detected in the video.
`GetLabelDetectionResult`	`withNextToken(String 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.
`GetLabelDetectionResult`	`withStatusMessage(String statusMessage)` If the job fails, `StatusMessage` provides a descriptive error message.
`GetLabelDetectionResult`	`withVideo(Video video)`
`GetLabelDetectionResult`	`withVideoMetadata(VideoMetadata videoMetadata)` Information about a video that Amazon Rekognition Video analyzed.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetLabelDetectionResult
```
public GetLabelDetectionResult()
```
- Method Detail
  - setJobStatus
```
public void setJobStatus(String jobStatus)
```
    The current status of the label detection job.
    
    Parameters:
    
    jobStatus - The current status of the label detection job.
    
    See Also:
    
    VideoJobStatus
  - getJobStatus
```
public String getJobStatus()
```
    The current status of the label detection job.
    
    Returns:
    
    The current status of the label detection job.
    
    See Also:
    
    VideoJobStatus
  - withJobStatus
```
public GetLabelDetectionResult withJobStatus(String jobStatus)
```
    The current status of the label detection job.
    
    Parameters:
    
    jobStatus - The current status of the label detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoJobStatus
  - withJobStatus
```
public GetLabelDetectionResult withJobStatus(VideoJobStatus jobStatus)
```
    The current status of the label detection job.
    
    Parameters:
    
    jobStatus - The current status of the label detection job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VideoJobStatus
  - setStatusMessage
```
public void setStatusMessage(String statusMessage)
```
    If the job fails, StatusMessage provides a descriptive error message.
    
    Parameters:
    
    statusMessage - If the job fails, StatusMessage provides a descriptive error message.
  - getStatusMessage
```
public String getStatusMessage()
```
    If the job fails, StatusMessage provides a descriptive error message.
    
    Returns:
    
    If the job fails, StatusMessage provides a descriptive error message.
  - withStatusMessage
```
public GetLabelDetectionResult withStatusMessage(String statusMessage)
```
    If the job fails, StatusMessage provides a descriptive error message.
    
    Parameters:
    
    statusMessage - If the job fails, StatusMessage provides a descriptive error message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVideoMetadata
```
public void setVideoMetadata(VideoMetadata 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.
    
    Parameters:
    
    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.
  - getVideoMetadata
```
public VideoMetadata getVideoMetadata()
```
    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.
  - withVideoMetadata
```
public GetLabelDetectionResult withVideoMetadata(VideoMetadata 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String 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.
    
    Parameters:
    
    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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public GetLabelDetectionResult withNextToken(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLabels
```
public List<LabelDetection> getLabels()
```
    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.
    
    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.
  - setLabels
```
public void setLabels(Collection<LabelDetection> 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.
    
    Parameters:
    
    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.
  - withLabels
```
public GetLabelDetectionResult withLabels(LabelDetection... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setLabels(java.util.Collection) or withLabels(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLabels
```
public GetLabelDetectionResult withLabels(Collection<LabelDetection> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLabelModelVersion
```
public void setLabelModelVersion(String labelModelVersion)
```
    Version number of the label detection model that was used to detect labels.
    
    Parameters:
    
    labelModelVersion - Version number of the label detection model that was used to detect labels.
  - getLabelModelVersion
```
public String getLabelModelVersion()
```
    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.
  - withLabelModelVersion
```
public GetLabelDetectionResult withLabelModelVersion(String labelModelVersion)
```
    Version number of the label detection model that was used to detect labels.
    
    Parameters:
    
    labelModelVersion - Version number of the label detection model that was used to detect labels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobId
```
public void setJobId(String 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.
    
    Parameters:
    
    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.
  - getJobId
```
public String getJobId()
```
    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.
  - withJobId
```
public GetLabelDetectionResult withJobId(String 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVideo
```
public void setVideo(Video video)
```
    Parameters:
    
    video -
  - getVideo
```
public Video getVideo()
```
    Returns:
  - withVideo
```
public GetLabelDetectionResult withVideo(Video video)
```
    Parameters:
    
    video -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setJobTag
```
public void setJobTag(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.
    
    Parameters:
    
    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.
  - getJobTag
```
public String getJobTag()
```
    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.
  - withJobTag
```
public GetLabelDetectionResult withJobTag(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGetRequestMetadata
```
public void setGetRequestMetadata(GetLabelDetectionRequestMetadata getRequestMetadata)
```
    Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
    
    Parameters:
    
    getRequestMetadata - Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
  - getGetRequestMetadata
```
public GetLabelDetectionRequestMetadata getGetRequestMetadata()
```
    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.
  - withGetRequestMetadata
```
public GetLabelDetectionResult withGetRequestMetadata(GetLabelDetectionRequestMetadata getRequestMetadata)
```
    Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
    
    Parameters:
    
    getRequestMetadata - Information about the paramters used when getting a response. Includes information on aggregation and sorting methods.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetLabelDetectionResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.779

Class GetLabelDetectionResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetLabelDetectionResult

Method Detail

setJobStatus

getJobStatus

withJobStatus

withJobStatus

setStatusMessage

getStatusMessage

withStatusMessage

setVideoMetadata

getVideoMetadata

withVideoMetadata

setNextToken

getNextToken

withNextToken

getLabels

setLabels

withLabels

withLabels

setLabelModelVersion

getLabelModelVersion

withLabelModelVersion

setJobId

getJobId

withJobId

setVideo

getVideo

withVideo

setJobTag

getJobTag

withJobTag

setGetRequestMetadata

getGetRequestMetadata

withGetRequestMetadata

toString

equals

hashCode

clone