MediaAnalysisJobDescription (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.rekognition.model.MediaAnalysisJobDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>

@Generated(value="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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MediaAnalysisJobDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MediaAnalysisJobDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MediaAnalysisJobDescription.Builder`	`builder()`
`Instant`	`completionTimestamp()` The Unix date and time when the job finished.
`Instant`	`creationTimestamp()` The Unix date and time when the job was started.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`MediaAnalysisJobFailureDetails`	`failureDetails()` Details about the error that resulted in failure of the job.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`MediaAnalysisInput`	`input()` Reference to the input manifest that was provided in the job creation request.
`String`	`jobId()` The identifier for a media analysis job.
`String`	`jobName()` The name of a media analysis job.
`String`	`kmsKeyId()` KMS Key that was provided in the creation request.
`MediaAnalysisManifestSummary`	`manifestSummary()` Provides statistics on input manifest and errors identified in the input manifest.
`MediaAnalysisOperationsConfig`	`operationsConfig()` Operation configurations that were provided during job creation.
`MediaAnalysisOutputConfig`	`outputConfig()` Output configuration that was provided in the creation request.
`MediaAnalysisResults`	`results()` Output manifest that contains prediction results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MediaAnalysisJobDescription.Builder>`	`serializableBuilderClass()`
`MediaAnalysisJobStatus`	`status()` The status of the media analysis job being retrieved.
`String`	`statusAsString()` The status of the media analysis job being retrieved.
`MediaAnalysisJobDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    MediaAnalysisJobStatus
  - 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:
    
    MediaAnalysisJobStatus
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class MediaAnalysisJobDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

jobId

jobName

operationsConfig

status

statusAsString

failureDetails

creationTimestamp

completionTimestamp

input

outputConfig

kmsKeyId

results

manifestSummary

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields