Class FraudsterRegistrationJob
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<FraudsterRegistrationJob.Builder,
FraudsterRegistrationJob>
Contains all the information about a fraudster registration job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
A timestamp of when the fraudster registration job was created.final String
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.final String
domainId()
The identifier of the domain that contains the fraudster registration job.final Instant
endedAt()
A timestamp of when the fraudster registration job ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FailureDetails
Contains details that are populated when an entire batch job fails.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.final String
jobId()
The service-generated identifier for the fraudster registration job.final String
jobName()
The client-provided name for the fraudster registration job.final JobProgress
Shows the completed percentage of registration requests listed in the input file.The current status of the fraudster registration job.final String
The current status of the fraudster registration job.final 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.final 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.static Class
<? extends FraudsterRegistrationJob.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createdAt
A timestamp of when the fraudster registration job was created.
- Returns:
- A timestamp of when the fraudster registration job was created.
-
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
The identifier of the domain that contains the fraudster registration job.
- Returns:
- The identifier of the domain that contains the fraudster registration job.
-
endedAt
A timestamp of when the fraudster registration job ended.
- Returns:
- A timestamp of when the fraudster registration job ended.
-
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
ofCOMPLETED_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
ofCOMPLETED_WITH_ERRORS
. You can use the job output file to identify the individual registration requests that failed.
-
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
The service-generated identifier for the fraudster registration job.
- Returns:
- The service-generated identifier for the fraudster registration job.
-
jobName
The client-provided name for the fraudster registration job.
- Returns:
- The client-provided name for the fraudster registration job.
-
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
The current status of the fraudster registration job.
If the service returns an enum value that is not available in the current SDK version,
jobStatus
will 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:
-
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,
jobStatus
will 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:
-
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
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
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 interfaceToCopyableBuilder<FraudsterRegistrationJob.Builder,
FraudsterRegistrationJob> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-