Class ListSpeakerEnrollmentJobsRequest

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.ListSpeakerEnrollmentJobsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListSpeakerEnrollmentJobsRequest.Builder,ListSpeakerEnrollmentJobsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListSpeakerEnrollmentJobsRequest extends VoiceIdRequest implements ToCopyableBuilder<ListSpeakerEnrollmentJobsRequest.Builder,ListSpeakerEnrollmentJobsRequest>

  • Method Details

    • domainId

      public final String domainId()

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

      Returns:
      The identifier of the domain that contains the speaker enrollment jobs.

    • jobStatus

      public final SpeakerEnrollmentJobStatus jobStatus()

      Provides the status of your 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:
      Provides the status of your speaker enrollment Job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      Provides the status of your 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:
      Provides the status of your speaker enrollment Job.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

      Returns:
      The maximum number of results that are returned per call. You can use NextToken to obtain more pages of results. The default is 100; the maximum allowed page size is also 100.

    • nextToken

      public final String nextToken()

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

      Returns:
      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.

    • toBuilder

      public ListSpeakerEnrollmentJobsRequest.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<ListSpeakerEnrollmentJobsRequest.Builder,ListSpeakerEnrollmentJobsRequest>
      Specified by:
      toBuilder in class VoiceIdRequest
      Returns:
      a builder for type T

    • builder

      public static ListSpeakerEnrollmentJobsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListSpeakerEnrollmentJobsRequest.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.