software.amazon.awssdk.services.voiceid.model

Interface SpeakerEnrollmentJob.Builder

All Superinterfaces:

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

Enclosing class:

SpeakerEnrollmentJob

public static interface SpeakerEnrollmentJob.Builder
extends SdkPojo, CopyableBuilder<SpeakerEnrollmentJob.Builder,SpeakerEnrollmentJob>

Method Summary

Modifier and Type	Method and Description
SpeakerEnrollmentJob.Builder	createdAt(Instant createdAt) A timestamp showing the creation of the speaker enrollment job.
SpeakerEnrollmentJob.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.
SpeakerEnrollmentJob.Builder	domainId(String domainId) The identifier of the domain that contains the speaker enrollment job.
SpeakerEnrollmentJob.Builder	endedAt(Instant endedAt) A timestamp showing when the speaker enrollment job ended.
default SpeakerEnrollmentJob.Builder	enrollmentConfig(Consumer<EnrollmentConfig.Builder> enrollmentConfig) The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
SpeakerEnrollmentJob.Builder	enrollmentConfig(EnrollmentConfig enrollmentConfig) The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
default SpeakerEnrollmentJob.Builder	failureDetails(Consumer<FailureDetails.Builder> failureDetails) Contains details that are populated when an entire batch job fails.
SpeakerEnrollmentJob.Builder	failureDetails(FailureDetails failureDetails) Contains details that are populated when an entire batch job fails.
default SpeakerEnrollmentJob.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
SpeakerEnrollmentJob.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
SpeakerEnrollmentJob.Builder	jobId(String jobId) The service-generated identifier for the speaker enrollment job.
SpeakerEnrollmentJob.Builder	jobName(String jobName) The client-provided name for the speaker enrollment job.
default SpeakerEnrollmentJob.Builder	jobProgress(Consumer<JobProgress.Builder> jobProgress) Provides details on job progress.
SpeakerEnrollmentJob.Builder	jobProgress(JobProgress jobProgress) Provides details on job progress.
SpeakerEnrollmentJob.Builder	jobStatus(SpeakerEnrollmentJobStatus jobStatus) The current status of the speaker enrollment job.
SpeakerEnrollmentJob.Builder	jobStatus(String jobStatus) The current status of the speaker enrollment job.
default SpeakerEnrollmentJob.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.
SpeakerEnrollmentJob.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.

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

createdAt

SpeakerEnrollmentJob.Builder createdAt(Instant createdAt)

A timestamp showing the creation of the speaker enrollment job.

Parameters:

createdAt - A timestamp showing the creation of the speaker enrollment job.

Returns:

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

dataAccessRoleArn

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

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.

Returns:

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

domainId

SpeakerEnrollmentJob.Builder domainId(String domainId)

The identifier of the domain that contains the speaker enrollment job.

Parameters:

domainId - The identifier of the domain that contains the speaker enrollment job.

Returns:

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

endedAt

SpeakerEnrollmentJob.Builder endedAt(Instant endedAt)

A timestamp showing when the speaker enrollment job ended.

Parameters:

endedAt - A timestamp showing when the speaker enrollment job ended.

Returns:

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

enrollmentConfig

SpeakerEnrollmentJob.Builder enrollmentConfig(EnrollmentConfig enrollmentConfig)

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

Parameters:

enrollmentConfig - The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

Returns:

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

enrollmentConfig

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

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.

This is a convenience method 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)

failureDetails

SpeakerEnrollmentJob.Builder failureDetails(FailureDetails failureDetails)

Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

Parameters:

failureDetails - Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

Returns:

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

failureDetails

default SpeakerEnrollmentJob.Builder failureDetails(Consumer<FailureDetails.Builder> failureDetails)

Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.

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

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

Parameters:

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

Returns:

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

See Also:

failureDetails(FailureDetails)

inputDataConfig

SpeakerEnrollmentJob.Builder inputDataConfig(InputDataConfig inputDataConfig)

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

Parameters:

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

Returns:

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

inputDataConfig

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

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

This is a convenience method 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)

jobId

SpeakerEnrollmentJob.Builder jobId(String jobId)

The service-generated identifier for the speaker enrollment job.

Parameters:

jobId - The service-generated identifier for the speaker enrollment job.

Returns:

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

jobName

SpeakerEnrollmentJob.Builder jobName(String jobName)

The client-provided name for the speaker enrollment job.

Parameters:

jobName - The client-provided name for the speaker enrollment job.

Returns:

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

jobProgress

SpeakerEnrollmentJob.Builder jobProgress(JobProgress jobProgress)

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

Parameters:

jobProgress - Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

Returns:

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

jobProgress

default SpeakerEnrollmentJob.Builder jobProgress(Consumer<JobProgress.Builder> jobProgress)

Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.

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

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

Parameters:

jobProgress - a consumer that will call methods on JobProgress.Builder

Returns:

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

See Also:

jobProgress(JobProgress)

jobStatus

SpeakerEnrollmentJob.Builder jobStatus(String jobStatus)

The current status of the speaker enrollment job.

Parameters:

jobStatus - The current status of the speaker enrollment job.

Returns:

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

See Also:

SpeakerEnrollmentJobStatus, SpeakerEnrollmentJobStatus

jobStatus

SpeakerEnrollmentJob.Builder jobStatus(SpeakerEnrollmentJobStatus jobStatus)

The current status of the speaker enrollment job.

Parameters:

jobStatus - The current status of the speaker enrollment job.

Returns:

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

See Also:

SpeakerEnrollmentJobStatus, SpeakerEnrollmentJobStatus

outputDataConfig

SpeakerEnrollmentJob.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 SpeakerEnrollmentJob.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 method 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)