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("software.amazon.awssdk:codegen") public final class StartSpeakerEnrollmentJobRequest extends VoiceIdRequest implements ToCopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartSpeakerEnrollmentJobRequest.Builder,StartSpeakerEnrollmentJobRequest>
      Specified by:
      toBuilder in class VoiceIdRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.