Class FraudsterRegistrationJob
- java.lang.Object
-
- software.amazon.awssdk.services.voiceid.model.FraudsterRegistrationJob
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FraudsterRegistrationJob.Builder,FraudsterRegistrationJob>
@Generated("software.amazon.awssdk:codegen") public final class FraudsterRegistrationJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FraudsterRegistrationJob.Builder,FraudsterRegistrationJob>
Contains all the information about a fraudster registration job.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceFraudsterRegistrationJob.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FraudsterRegistrationJob.Builderbuilder()InstantcreatedAt()A timestamp of when the fraudster registration job was created.StringdataAccessRoleArn()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.StringdomainId()The identifier of the domain that contains the fraudster registration job.InstantendedAt()A timestamp of when the fraudster registration job ended.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)FailureDetailsfailureDetails()Contains details that are populated when an entire batch job fails.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()InputDataConfiginputDataConfig()The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.StringjobId()The service-generated identifier for the fraudster registration job.StringjobName()The client-provided name for the fraudster registration job.JobProgressjobProgress()Shows the completed percentage of registration requests listed in the input file.FraudsterRegistrationJobStatusjobStatus()The current status of the fraudster registration job.StringjobStatusAsString()The current status of the fraudster registration job.OutputDataConfigoutputDataConfig()The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.RegistrationConfigregistrationConfig()The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.List<SdkField<?>>sdkFields()static Class<? extends FraudsterRegistrationJob.Builder>serializableBuilderClass()FraudsterRegistrationJob.BuildertoBuilder()StringtoString()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 fraudster registration job was created.
- Returns:
- A timestamp of when the fraudster registration 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 fraudster registration job.
- Returns:
- The identifier of the domain that contains the fraudster registration job.
-
endedAt
public final Instant endedAt()
A timestamp of when the fraudster registration job ended.
- Returns:
- A timestamp of when the fraudster registration 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
JobStatusofCOMPLETED_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
JobStatusofCOMPLETED_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 fraudster registration job requests.
- Returns:
- The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
-
jobId
public final String jobId()
The service-generated identifier for the fraudster registration job.
- Returns:
- The service-generated identifier for the fraudster registration job.
-
jobName
public final String jobName()
The client-provided name for the fraudster registration job.
- Returns:
- The client-provided name for the fraudster registration job.
-
jobProgress
public final JobProgress jobProgress()
Shows the completed percentage of registration requests listed in the input file.
- Returns:
- Shows the completed percentage of registration requests listed in the input file.
-
jobStatus
public final FraudsterRegistrationJobStatus jobStatus()
The current status of the fraudster registration job.
If the service returns an enum value that is not available in the current SDK version,
jobStatuswill returnFraudsterRegistrationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobStatusAsString().- Returns:
- The current status of the fraudster registration job.
- See Also:
FraudsterRegistrationJobStatus
-
jobStatusAsString
public final String jobStatusAsString()
The current status of the fraudster registration job.
If the service returns an enum value that is not available in the current SDK version,
jobStatuswill returnFraudsterRegistrationJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromjobStatusAsString().- Returns:
- The current status of the fraudster registration job.
- See Also:
FraudsterRegistrationJobStatus
-
outputDataConfig
public final OutputDataConfig outputDataConfig()
The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
- Returns:
- The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.
-
registrationConfig
public final RegistrationConfig registrationConfig()
The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
- Returns:
- The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
-
toBuilder
public FraudsterRegistrationJob.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<FraudsterRegistrationJob.Builder,FraudsterRegistrationJob>
-
builder
public static FraudsterRegistrationJob.Builder builder()
-
serializableBuilderClass
public static Class<? extends FraudsterRegistrationJob.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-