software.amazon.awssdk.services.voiceid.model

Class SpeakerEnrollmentJobSummary

java.lang.Object

software.amazon.awssdk.services.voiceid.model.SpeakerEnrollmentJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SpeakerEnrollmentJobSummary.Builder,SpeakerEnrollmentJobSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class SpeakerEnrollmentJobSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SpeakerEnrollmentJobSummary.Builder,SpeakerEnrollmentJobSummary>

Contains a summary of information about a speaker enrollment job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SpeakerEnrollmentJobSummary.Builder

Method Summary

Modifier and Type	Method and Description
static SpeakerEnrollmentJobSummary.Builder	builder()
Instant	createdAt() A timestamp showing the creation time of the speaker enrollment job.
String	domainId() The identifier of the domain that contains the speaker enrollment job.
Instant	endedAt() A timestamp showing when the speaker enrollment job ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FailureDetails	failureDetails() Contains details that are populated when an entire batch job fails.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	jobId() The service-generated identifier for the speaker enrollment job.
String	jobName() The client-provided name for the speaker enrollment job.
JobProgress	jobProgress() Provides details regarding job progress.
SpeakerEnrollmentJobStatus	jobStatus() The current status of the speaker enrollment job.
String	jobStatusAsString() The current status of the speaker enrollment job.
List<SdkField<?>>	sdkFields()
static Class<? extends SpeakerEnrollmentJobSummary.Builder>	serializableBuilderClass()
SpeakerEnrollmentJobSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

createdAt

public final Instant createdAt()

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

Returns:

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

domainId

public final String domainId()

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

Returns:

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

endedAt

public final Instant endedAt()

A timestamp showing when the speaker enrollment job ended.

Returns:

A timestamp showing when the speaker enrollment job ended.

failureDetails

public final 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.

Returns:

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.

jobId

public final String jobId()

The service-generated identifier for the speaker enrollment job.

Returns:

The service-generated identifier for the speaker enrollment job.

jobName

public final String jobName()

The client-provided name for the speaker enrollment job.

Returns:

The client-provided name for the speaker enrollment job.

jobProgress

public final JobProgress jobProgress()

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

Returns:

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

jobStatus

public final SpeakerEnrollmentJobStatus jobStatus()

The current status of the speaker enrollment job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return SpeakerEnrollmentJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the speaker enrollment job.

See Also:

SpeakerEnrollmentJobStatus

jobStatusAsString

public final String jobStatusAsString()

The current status of the speaker enrollment job.

If the service returns an enum value that is not available in the current SDK version, jobStatus will return SpeakerEnrollmentJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

Returns:

The current status of the speaker enrollment job.

See Also:

SpeakerEnrollmentJobStatus

toBuilder

public SpeakerEnrollmentJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SpeakerEnrollmentJobSummary.Builder,SpeakerEnrollmentJobSummary>

builder

public static SpeakerEnrollmentJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends SpeakerEnrollmentJobSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo