software.amazon.awssdk.services.voiceid.model

Interface SpeakerEnrollmentJobSummary.Builder

All Superinterfaces:

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

Enclosing class:

SpeakerEnrollmentJobSummary

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

Method Summary

Modifier and Type	Method and Description
SpeakerEnrollmentJobSummary.Builder	createdAt(Instant createdAt) A timestamp showing the creation time of the speaker enrollment job.
SpeakerEnrollmentJobSummary.Builder	domainId(String domainId) The identifier of the domain that contains the speaker enrollment job.
SpeakerEnrollmentJobSummary.Builder	endedAt(Instant endedAt) A timestamp showing when the speaker enrollment job ended.
default SpeakerEnrollmentJobSummary.Builder	failureDetails(Consumer<FailureDetails.Builder> failureDetails) Contains details that are populated when an entire batch job fails.
SpeakerEnrollmentJobSummary.Builder	failureDetails(FailureDetails failureDetails) Contains details that are populated when an entire batch job fails.
SpeakerEnrollmentJobSummary.Builder	jobId(String jobId) The service-generated identifier for the speaker enrollment job.
SpeakerEnrollmentJobSummary.Builder	jobName(String jobName) The client-provided name for the speaker enrollment job.
default SpeakerEnrollmentJobSummary.Builder	jobProgress(Consumer<JobProgress.Builder> jobProgress) Provides details regarding job progress.
SpeakerEnrollmentJobSummary.Builder	jobProgress(JobProgress jobProgress) Provides details regarding job progress.
SpeakerEnrollmentJobSummary.Builder	jobStatus(SpeakerEnrollmentJobStatus jobStatus) The current status of the speaker enrollment job.
SpeakerEnrollmentJobSummary.Builder	jobStatus(String jobStatus) The current status of the speaker enrollment job.

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

SpeakerEnrollmentJobSummary.Builder createdAt(Instant createdAt)

A timestamp showing the creation time of the speaker enrollment job.

Parameters:

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

Returns:

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

domainId

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

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

failureDetails

SpeakerEnrollmentJobSummary.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 SpeakerEnrollmentJobSummary.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)

jobId

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

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

SpeakerEnrollmentJobSummary.Builder jobProgress(JobProgress jobProgress)

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

Parameters:

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

Returns:

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

jobProgress

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

Provides details regarding job progress. This field shows the completed percentage of enrollment 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

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

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