software.amazon.awssdk.services.voiceid.model

Class StartSpeakerEnrollmentJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.voiceid.model.VoiceIdRequest

software.amazon.awssdk.services.voiceid.model.StartSpeakerEnrollmentJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartSpeakerEnrollmentJobRequest
extends VoiceIdRequest
implements ToCopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StartSpeakerEnrollmentJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static StartSpeakerEnrollmentJobRequest.Builder	builder()
String	clientToken() The idempotency token for starting a new speaker enrollment Job.
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 and in which the speakers are enrolled.
EnrollmentConfig	enrollmentConfig() The enrollment config that contains details such as the action to take when a speaker is already enrolled in Voice ID or when a speaker is identified as a fraudster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
InputDataConfig	inputDataConfig() The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
String	jobName() A name for your 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 StartSpeakerEnrollmentJobRequest.Builder>	serializableBuilderClass()
StartSpeakerEnrollmentJobRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

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

Returns:

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

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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

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. Refer to Batch enrollment using audio data from prior calls for the permissions needed in this role.

domainId

public final String domainId()

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

Returns:

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

enrollmentConfig

public final EnrollmentConfig enrollmentConfig()

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

Returns:

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

inputDataConfig

public final InputDataConfig inputDataConfig()

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

Returns:

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

jobName

public final String jobName()

A name for your speaker enrollment job.

Returns:

A name for your speaker enrollment job.

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 StartSpeakerEnrollmentJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>

Specified by:

toBuilder in class VoiceIdRequest

builder

public static StartSpeakerEnrollmentJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo