software.amazon.awssdk.services.voiceid.model

Interface StartSpeakerEnrollmentJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>, SdkBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>, SdkPojo, SdkRequest.Builder, VoiceIdRequest.Builder

Enclosing class:

StartSpeakerEnrollmentJobRequest

public static interface StartSpeakerEnrollmentJobRequest.Builder
extends VoiceIdRequest.Builder, SdkPojo, CopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>

Method Summary

Modifier and Type	Method and Description
StartSpeakerEnrollmentJobRequest.Builder	clientToken(String clientToken) The idempotency token for starting a new speaker enrollment Job.
StartSpeakerEnrollmentJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn) The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file.
StartSpeakerEnrollmentJobRequest.Builder	domainId(String domainId) The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
default StartSpeakerEnrollmentJobRequest.Builder	enrollmentConfig(Consumer<EnrollmentConfig.Builder> enrollmentConfig) The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.
StartSpeakerEnrollmentJobRequest.Builder	enrollmentConfig(EnrollmentConfig enrollmentConfig) The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.
default StartSpeakerEnrollmentJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
StartSpeakerEnrollmentJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
StartSpeakerEnrollmentJobRequest.Builder	jobName(String jobName) A name for your speaker enrollment job.
default StartSpeakerEnrollmentJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
StartSpeakerEnrollmentJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig) The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
StartSpeakerEnrollmentJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartSpeakerEnrollmentJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.voiceid.model.VoiceIdRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

clientToken

StartSpeakerEnrollmentJobRequest.Builder clientToken(String clientToken)

The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

Parameters:

clientToken - The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.

Returns:

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

dataAccessRoleArn

StartSpeakerEnrollmentJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to Batch enrollment using audio data from prior calls documentation for the permissions needed in this role.

Parameters:

dataAccessRoleArn - The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to Batch enrollment using audio data from prior calls documentation for the permissions needed in this role.

Returns:

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

domainId

StartSpeakerEnrollmentJobRequest.Builder domainId(String domainId)

The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

Parameters:

domainId - The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.

Returns:

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

enrollmentConfig

StartSpeakerEnrollmentJobRequest.Builder enrollmentConfig(EnrollmentConfig enrollmentConfig)

The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.

Parameters:

enrollmentConfig - The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.

Returns:

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

enrollmentConfig

default StartSpeakerEnrollmentJobRequest.Builder enrollmentConfig(Consumer<EnrollmentConfig.Builder> enrollmentConfig)

The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.

This is a convenience that creates an instance of the EnrollmentConfig.Builder avoiding the need to create one manually via EnrollmentConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to enrollmentConfig(EnrollmentConfig).

Parameters:

enrollmentConfig - a consumer that will call methods on EnrollmentConfig.Builder

Returns:

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

See Also:

enrollmentConfig(EnrollmentConfig)

inputDataConfig

StartSpeakerEnrollmentJobRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

Parameters:

inputDataConfig - The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

Returns:

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

inputDataConfig

default StartSpeakerEnrollmentJobRequest.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.

This is a convenience that creates an instance of the InputDataConfig.Builder avoiding the need to create one manually via InputDataConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

Parameters:

inputDataConfig - a consumer that will call methods on InputDataConfig.Builder

Returns:

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

See Also:

inputDataConfig(InputDataConfig)

jobName

StartSpeakerEnrollmentJobRequest.Builder jobName(String jobName)

A name for your speaker enrollment job.

Parameters:

jobName - A name for your speaker enrollment job.

Returns:

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

outputDataConfig

StartSpeakerEnrollmentJobRequest.Builder outputDataConfig(OutputDataConfig outputDataConfig)

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Parameters:

outputDataConfig - The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

Returns:

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

outputDataConfig

default StartSpeakerEnrollmentJobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.

This is a convenience that creates an instance of the OutputDataConfig.Builder avoiding the need to create one manually via OutputDataConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(OutputDataConfig).

Parameters:

outputDataConfig - a consumer that will call methods on OutputDataConfig.Builder

Returns:

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

See Also:

outputDataConfig(OutputDataConfig)

overrideConfiguration

StartSpeakerEnrollmentJobRequest.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

StartSpeakerEnrollmentJobRequest.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.