Interface StartMediaAnalysisJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>, RekognitionRequest.Builder, SdkBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartMediaAnalysisJobRequest

public static interface StartMediaAnalysisJobRequest.Builder
extends RekognitionRequest.Builder, SdkPojo, CopyableBuilder<StartMediaAnalysisJobRequest.Builder,StartMediaAnalysisJobRequest>

Method Summary

Modifier and Type	Method	Description
StartMediaAnalysisJobRequest.Builder	clientRequestToken(String clientRequestToken)	Idempotency token used to prevent the accidental creation of duplicate versions.
default StartMediaAnalysisJobRequest.Builder	input(Consumer<MediaAnalysisInput.Builder> input)	Input data to be analyzed by the job.
StartMediaAnalysisJobRequest.Builder	input(MediaAnalysisInput input)	Input data to be analyzed by the job.
StartMediaAnalysisJobRequest.Builder	jobName(String jobName)	The name of the job.
StartMediaAnalysisJobRequest.Builder	kmsKeyId(String kmsKeyId)	The identifier of customer managed AWS KMS key (name or ARN).
default StartMediaAnalysisJobRequest.Builder	operationsConfig(Consumer<MediaAnalysisOperationsConfig.Builder> operationsConfig)	Configuration options for the media analysis job to be created.
StartMediaAnalysisJobRequest.Builder	operationsConfig(MediaAnalysisOperationsConfig operationsConfig)	Configuration options for the media analysis job to be created.
default StartMediaAnalysisJobRequest.Builder	outputConfig(Consumer<MediaAnalysisOutputConfig.Builder> outputConfig)	The Amazon S3 bucket location to store the results.
StartMediaAnalysisJobRequest.Builder	outputConfig(MediaAnalysisOutputConfig outputConfig)	The Amazon S3 bucket location to store the results.
StartMediaAnalysisJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartMediaAnalysisJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.rekognition.model.RekognitionRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

clientRequestToken

StartMediaAnalysisJobRequest.Builder clientRequestToken(String clientRequestToken)

Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Parameters:

clientRequestToken - Idempotency token used to prevent the accidental creation of duplicate versions. If you use the same token with multiple StartMediaAnalysisJobRequest requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Returns:

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

jobName

StartMediaAnalysisJobRequest.Builder jobName(String jobName)

The name of the job. Does not have to be unique.

Parameters:

jobName - The name of the job. Does not have to be unique.

Returns:

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

operationsConfig

StartMediaAnalysisJobRequest.Builder operationsConfig(MediaAnalysisOperationsConfig operationsConfig)

Configuration options for the media analysis job to be created.

Parameters:

operationsConfig - Configuration options for the media analysis job to be created.

Returns:

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

operationsConfig

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

Configuration options for the media analysis job to be created.

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)

input

StartMediaAnalysisJobRequest.Builder input(MediaAnalysisInput input)

Input data to be analyzed by the job.

Parameters:

input - Input data to be analyzed by the job.

Returns:

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

input

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

Input data to be analyzed by the job.

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

StartMediaAnalysisJobRequest.Builder outputConfig(MediaAnalysisOutputConfig outputConfig)

The Amazon S3 bucket location to store the results.

Parameters:

outputConfig - The Amazon S3 bucket location to store the results.

Returns:

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

outputConfig

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

The Amazon S3 bucket location to store the results.

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

StartMediaAnalysisJobRequest.Builder kmsKeyId(String kmsKeyId)

The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

Parameters:

kmsKeyId - The identifier of customer managed AWS KMS key (name or ARN). The key is used to encrypt images copied into the service. The key is also used to encrypt results and manifest files written to the output Amazon S3 bucket.

Returns:

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

overrideConfiguration

StartMediaAnalysisJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartMediaAnalysisJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.