Class MediaAnalysisJobDescription

java.lang.Object
software.amazon.awssdk.services.rekognition.model.MediaAnalysisJobDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>
@Generated("software.amazon.awssdk:codegen") public final class MediaAnalysisJobDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>

Description for a media analysis job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The identifier for a media analysis job.

      Returns:
      The identifier for a media analysis job.

    • jobName

      public final String jobName()

      The name of a media analysis job.

      Returns:
      The name of a media analysis job.

    • operationsConfig

      public final MediaAnalysisOperationsConfig operationsConfig()

      Operation configurations that were provided during job creation.

      Returns:
      Operation configurations that were provided during job creation.

    • status

      public final MediaAnalysisJobStatus status()

      The status of the media analysis job being retrieved.

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

      Returns:
      The status of the media analysis job being retrieved.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the media analysis job being retrieved.

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

      Returns:
      The status of the media analysis job being retrieved.
      See Also:

    • failureDetails

      public final MediaAnalysisJobFailureDetails failureDetails()

      Details about the error that resulted in failure of the job.

      Returns:
      Details about the error that resulted in failure of the job.

    • creationTimestamp

      public final Instant creationTimestamp()

      The Unix date and time when the job was started.

      Returns:
      The Unix date and time when the job was started.

    • completionTimestamp

      public final Instant completionTimestamp()

      The Unix date and time when the job finished.

      Returns:
      The Unix date and time when the job finished.

    • input

      public final MediaAnalysisInput input()

      Reference to the input manifest that was provided in the job creation request.

      Returns:
      Reference to the input manifest that was provided in the job creation request.

    • outputConfig

      public final MediaAnalysisOutputConfig outputConfig()

      Output configuration that was provided in the creation request.

      Returns:
      Output configuration that was provided in the creation request.

    • kmsKeyId

      public final String kmsKeyId()

      KMS Key that was provided in the creation request.

      Returns:
      KMS Key that was provided in the creation request.

    • results

      public final MediaAnalysisResults results()

      Output manifest that contains prediction results.

      Returns:
      Output manifest that contains prediction results.

    • manifestSummary

      public final MediaAnalysisManifestSummary manifestSummary()

      Provides statistics on input manifest and errors identified in the input manifest.

      Returns:
      Provides statistics on input manifest and errors identified in the input manifest.

    • toBuilder

      public MediaAnalysisJobDescription.Builder 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 interface ToCopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>
      Returns:
      a builder for type T

    • builder

      public static MediaAnalysisJobDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MediaAnalysisJobDescription.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.