Interface MediaAnalysisJobDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>, SdkBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>, SdkPojo

Enclosing class:

MediaAnalysisJobDescription

@Mutable
@NotThreadSafe
public static interface MediaAnalysisJobDescription.Builder
extends SdkPojo, CopyableBuilder<MediaAnalysisJobDescription.Builder,MediaAnalysisJobDescription>

Method Summary

Modifier and Type	Method	Description
MediaAnalysisJobDescription.Builder	completionTimestamp(Instant completionTimestamp)	The Unix date and time when the job finished.
MediaAnalysisJobDescription.Builder	creationTimestamp(Instant creationTimestamp)	The Unix date and time when the job was started.
default MediaAnalysisJobDescription.Builder	failureDetails(Consumer<MediaAnalysisJobFailureDetails.Builder> failureDetails)	Details about the error that resulted in failure of the job.
MediaAnalysisJobDescription.Builder	failureDetails(MediaAnalysisJobFailureDetails failureDetails)	Details about the error that resulted in failure of the job.
default MediaAnalysisJobDescription.Builder	input(Consumer<MediaAnalysisInput.Builder> input)	Reference to the input manifest that was provided in the job creation request.
MediaAnalysisJobDescription.Builder	input(MediaAnalysisInput input)	Reference to the input manifest that was provided in the job creation request.
MediaAnalysisJobDescription.Builder	jobId(String jobId)	The identifier for a media analysis job.
MediaAnalysisJobDescription.Builder	jobName(String jobName)	The name of a media analysis job.
MediaAnalysisJobDescription.Builder	kmsKeyId(String kmsKeyId)	KMS Key that was provided in the creation request.
default MediaAnalysisJobDescription.Builder	manifestSummary(Consumer<MediaAnalysisManifestSummary.Builder> manifestSummary)	Provides statistics on input manifest and errors identified in the input manifest.
MediaAnalysisJobDescription.Builder	manifestSummary(MediaAnalysisManifestSummary manifestSummary)	Provides statistics on input manifest and errors identified in the input manifest.
default MediaAnalysisJobDescription.Builder	operationsConfig(Consumer<MediaAnalysisOperationsConfig.Builder> operationsConfig)	Operation configurations that were provided during job creation.
MediaAnalysisJobDescription.Builder	operationsConfig(MediaAnalysisOperationsConfig operationsConfig)	Operation configurations that were provided during job creation.
default MediaAnalysisJobDescription.Builder	outputConfig(Consumer<MediaAnalysisOutputConfig.Builder> outputConfig)	Output configuration that was provided in the creation request.
MediaAnalysisJobDescription.Builder	outputConfig(MediaAnalysisOutputConfig outputConfig)	Output configuration that was provided in the creation request.
default MediaAnalysisJobDescription.Builder	results(Consumer<MediaAnalysisResults.Builder> results)	Output manifest that contains prediction results.
MediaAnalysisJobDescription.Builder	results(MediaAnalysisResults results)	Output manifest that contains prediction results.
MediaAnalysisJobDescription.Builder	status(String status)	The status of the media analysis job being retrieved.
MediaAnalysisJobDescription.Builder	status(MediaAnalysisJobStatus status)	The status of the media analysis job being retrieved.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

jobId

MediaAnalysisJobDescription.Builder jobId(String jobId)

The identifier for a media analysis job.

Parameters:

jobId - The identifier for a media analysis job.

Returns:

Returns a reference to this object so that method calls can be chained together.

jobName

MediaAnalysisJobDescription.Builder jobName(String jobName)

The name of a media analysis job.

Parameters:

jobName - The name of a media analysis job.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationsConfig

MediaAnalysisJobDescription.Builder operationsConfig(MediaAnalysisOperationsConfig operationsConfig)

Operation configurations that were provided during job creation.

Parameters:

operationsConfig - Operation configurations that were provided during job creation.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationsConfig

default MediaAnalysisJobDescription.Builder operationsConfig(Consumer<MediaAnalysisOperationsConfig.Builder> operationsConfig)

Operation configurations that were provided during job creation.

This is a convenience method that creates an instance of the MediaAnalysisOperationsConfig.Builder avoiding the need to create one manually via MediaAnalysisOperationsConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to operationsConfig(MediaAnalysisOperationsConfig).

Parameters:

operationsConfig - a consumer that will call methods on MediaAnalysisOperationsConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• operationsConfig(MediaAnalysisOperationsConfig)

status

MediaAnalysisJobDescription.Builder status(String status)

The status of the media analysis job being retrieved.

Parameters:

status - The status of the media analysis job being retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaAnalysisJobStatus
• MediaAnalysisJobStatus

status

MediaAnalysisJobDescription.Builder status(MediaAnalysisJobStatus status)

The status of the media analysis job being retrieved.

Parameters:

status - The status of the media analysis job being retrieved.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• MediaAnalysisJobStatus
• MediaAnalysisJobStatus

failureDetails

MediaAnalysisJobDescription.Builder failureDetails(MediaAnalysisJobFailureDetails failureDetails)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

failureDetails

default MediaAnalysisJobDescription.Builder failureDetails(Consumer<MediaAnalysisJobFailureDetails.Builder> failureDetails)

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

This is a convenience method that creates an instance of the MediaAnalysisJobFailureDetails.Builder avoiding the need to create one manually via MediaAnalysisJobFailureDetails.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to failureDetails(MediaAnalysisJobFailureDetails).

Parameters:

failureDetails - a consumer that will call methods on MediaAnalysisJobFailureDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• failureDetails(MediaAnalysisJobFailureDetails)

creationTimestamp

MediaAnalysisJobDescription.Builder creationTimestamp(Instant creationTimestamp)

The Unix date and time when the job was started.

Parameters:

creationTimestamp - The Unix date and time when the job was started.

Returns:

Returns a reference to this object so that method calls can be chained together.

completionTimestamp

MediaAnalysisJobDescription.Builder completionTimestamp(Instant completionTimestamp)

The Unix date and time when the job finished.

Parameters:

completionTimestamp - The Unix date and time when the job finished.

Returns:

Returns a reference to this object so that method calls can be chained together.

input

MediaAnalysisJobDescription.Builder input(MediaAnalysisInput input)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

input

default MediaAnalysisJobDescription.Builder input(Consumer<MediaAnalysisInput.Builder> input)

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

This is a convenience method that creates an instance of the MediaAnalysisInput.Builder avoiding the need to create one manually via MediaAnalysisInput.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to input(MediaAnalysisInput).

Parameters:

input - a consumer that will call methods on MediaAnalysisInput.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• input(MediaAnalysisInput)

outputConfig

MediaAnalysisJobDescription.Builder outputConfig(MediaAnalysisOutputConfig outputConfig)

Output configuration that was provided in the creation request.

Parameters:

outputConfig - Output configuration that was provided in the creation request.

Returns:

Returns a reference to this object so that method calls can be chained together.

outputConfig

default MediaAnalysisJobDescription.Builder outputConfig(Consumer<MediaAnalysisOutputConfig.Builder> outputConfig)

Output configuration that was provided in the creation request.

This is a convenience method that creates an instance of the MediaAnalysisOutputConfig.Builder avoiding the need to create one manually via MediaAnalysisOutputConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputConfig(MediaAnalysisOutputConfig).

Parameters:

outputConfig - a consumer that will call methods on MediaAnalysisOutputConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• outputConfig(MediaAnalysisOutputConfig)

kmsKeyId

MediaAnalysisJobDescription.Builder kmsKeyId(String kmsKeyId)

KMS Key that was provided in the creation request.

Parameters:

kmsKeyId - KMS Key that was provided in the creation request.

Returns:

Returns a reference to this object so that method calls can be chained together.

results

MediaAnalysisJobDescription.Builder results(MediaAnalysisResults results)

Output manifest that contains prediction results.

Parameters:

results - Output manifest that contains prediction results.

Returns:

Returns a reference to this object so that method calls can be chained together.

results

default MediaAnalysisJobDescription.Builder results(Consumer<MediaAnalysisResults.Builder> results)

Output manifest that contains prediction results.

This is a convenience method that creates an instance of the MediaAnalysisResults.Builder avoiding the need to create one manually via MediaAnalysisResults.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to results(MediaAnalysisResults).

Parameters:

results - a consumer that will call methods on MediaAnalysisResults.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• results(MediaAnalysisResults)

manifestSummary

MediaAnalysisJobDescription.Builder manifestSummary(MediaAnalysisManifestSummary manifestSummary)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

manifestSummary

default MediaAnalysisJobDescription.Builder manifestSummary(Consumer<MediaAnalysisManifestSummary.Builder> manifestSummary)

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

This is a convenience method that creates an instance of the MediaAnalysisManifestSummary.Builder avoiding the need to create one manually via MediaAnalysisManifestSummary.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to manifestSummary(MediaAnalysisManifestSummary).

Parameters:

manifestSummary - a consumer that will call methods on MediaAnalysisManifestSummary.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• manifestSummary(MediaAnalysisManifestSummary)