Package software.amazon.awssdk.services.rekognition.model

Class GetContentModerationResponse

    • Method Detail

      • jobStatus

        public final VideoJobStatus jobStatus()

        The current status of the content moderation analysis job.

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

        Returns:
        The current status of the content moderation analysis job.
        See Also:
        VideoJobStatus

      • jobStatusAsString

        public final String jobStatusAsString()

        The current status of the content moderation analysis job.

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

        Returns:
        The current status of the content moderation analysis job.
        See Also:
        VideoJobStatus

      • statusMessage

        public final String statusMessage()

        If the job fails, StatusMessage provides a descriptive error message.

        Returns:
        If the job fails, StatusMessage provides a descriptive error message.

      • videoMetadata

        public final VideoMetadata videoMetadata()

        Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.

        Returns:
        Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from GetContentModeration.

      • hasModerationLabels

        public final boolean hasModerationLabels()
        For responses, this returns true if the service returned a value for the ModerationLabels 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.

      • moderationLabels

        public final List<ContentModerationDetection> moderationLabels()

        The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were 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 hasModerationLabels() method.

        Returns:
        The detected inappropriate, unwanted, or offensive content moderation labels and the time(s) they were detected.

      • nextToken

        public final 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 content moderation 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 content moderation labels.

      • moderationModelVersion

        public final String moderationModelVersion()

        Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

        Returns:
        Version number of the moderation detection model that was used to detect inappropriate, unwanted, or offensive content.

      • jobId

        public final String jobId()

        Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.

        Returns:
        Job identifier for the content moderation operation for which you want to obtain results. The job identifer is returned by an initial call to StartContentModeration.

      • video

        public final Video video()
        Returns the value of the Video property for this object.
        Returns:
        The value of the Video property for this object.

      • jobTag

        public final String jobTag()

        A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

        Returns:
        A job identifier specified in the call to StartContentModeration and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

      • getRequestMetadata

        public final GetContentModerationRequestMetadata 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.

      • 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