java.lang.Object
- software.amazon.awssdk.services.voiceid.model.SpeakerEnrollmentJob

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SpeakerEnrollmentJob.Builder,SpeakerEnrollmentJob>

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

Contains all the information about a speaker enrollment job.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SpeakerEnrollmentJob.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SpeakerEnrollmentJob.Builder`	`builder()`
`Instant`	`createdAt()`	A timestamp of when the speaker enrollment job was created.
`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.
`String`	`domainId()`	The identifier of the domain that contains the speaker enrollment job.
`Instant`	`endedAt()`	A timestamp of when the speaker enrollment job ended.
`EnrollmentConfig`	`enrollmentConfig()`	The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the `FraudDetectionConfig` to use.
`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()`
`InputDataConfig`	`inputDataConfig()`	The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
`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 on job progress.
`SpeakerEnrollmentJobStatus`	`jobStatus()`	The current status of the speaker enrollment job.
`String`	`jobStatusAsString()`	The current status of the speaker enrollment job.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SpeakerEnrollmentJob.Builder>`	`serializableBuilderClass()`
`SpeakerEnrollmentJob.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 of when the speaker enrollment job was created.
    
    Returns:
    
    A timestamp of when the speaker enrollment job was created.
  - dataAccessRoleArn
```
public final 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.
    
    Returns:
    
    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.
  - 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 of when the speaker enrollment job ended.
    
    Returns:
    
    A timestamp of when the speaker enrollment job ended.
  - enrollmentConfig
```
public final EnrollmentConfig enrollmentConfig()
```
    The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
    
    Returns:
    
    The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig to use.
  - 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.
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
    
    Returns:
    
    The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
  - 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 on job progress. This field shows the completed percentage of registration requests listed in the input file.
    
    Returns:
    
    Provides details on job progress. This field shows the completed percentage of registration 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
  - outputDataConfig
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public SpeakerEnrollmentJob.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SpeakerEnrollmentJob.Builder,SpeakerEnrollmentJob>
  - builder
```
public static SpeakerEnrollmentJob.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SpeakerEnrollmentJob.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

Class SpeakerEnrollmentJob

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

createdAt

dataAccessRoleArn

domainId

endedAt

enrollmentConfig

failureDetails

inputDataConfig

jobId

jobName

jobProgress

jobStatus

jobStatusAsString

outputDataConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields