Class TopicsDetectionJobProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TopicsDetectionJobProperties.Builder,
TopicsDetectionJobProperties>
Provides information about a topic detection job.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.final Instant
endTime()
The time that the topic detection job was completed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final InputDataConfig
The input data configuration supplied when you created the topic detection job.final String
jobArn()
The Amazon Resource Name (ARN) of the topics detection job.final String
jobId()
The identifier assigned to the topic detection job.final String
jobName()
The name of the topic detection job.final JobStatus
The current status of the topic detection job.final String
The current status of the topic detection job.final String
message()
A description for the status of a job.final Integer
The number of topics to detect supplied when you created the topic detection job.final OutputDataConfig
The output data configuration supplied when you created the topic detection job.static Class
<? extends TopicsDetectionJobProperties.Builder> final Instant
The time that the topic detection job was submitted for processing.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.final String
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job.final VpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobId
The identifier assigned to the topic detection job.
- Returns:
- The identifier assigned to the topic detection job.
-
jobArn
The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
- Returns:
- The Amazon Resource Name (ARN) of the topics detection job. It is a unique, fully qualified identifier
for the job. It includes the Amazon Web Services account, Amazon Web Services Region, and the job ID. The
format of the ARN is as follows:
arn:<partition>:comprehend:<region>:<account-id>:topics-detection-job/<job-id>
The following is an example job ARN:
arn:aws:comprehend:us-west-2:111122223333:topics-detection-job/1234abcd12ab34cd56ef1234567890ab
-
jobName
The name of the topic detection job.
- Returns:
- The name of the topic detection job.
-
jobStatus
The current status of the topic detection job. If the status is
Failed
, the reason for the failure is shown in theMessage
field.If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the topic detection job. If the status is
Failed
, the reason for the failure is shown in theMessage
field. - See Also:
-
jobStatusAsString
The current status of the topic detection job. If the status is
Failed
, the reason for the failure is shown in theMessage
field.If the service returns an enum value that is not available in the current SDK version,
jobStatus
will returnJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromjobStatusAsString()
.- Returns:
- The current status of the topic detection job. If the status is
Failed
, the reason for the failure is shown in theMessage
field. - See Also:
-
message
A description for the status of a job.
- Returns:
- A description for the status of a job.
-
submitTime
The time that the topic detection job was submitted for processing.
- Returns:
- The time that the topic detection job was submitted for processing.
-
endTime
The time that the topic detection job was completed.
- Returns:
- The time that the topic detection job was completed.
-
inputDataConfig
The input data configuration supplied when you created the topic detection job.
- Returns:
- The input data configuration supplied when you created the topic detection job.
-
outputDataConfig
The output data configuration supplied when you created the topic detection job.
- Returns:
- The output data configuration supplied when you created the topic detection job.
-
numberOfTopics
The number of topics to detect supplied when you created the topic detection job. The default is 10.
- Returns:
- The number of topics to detect supplied when you created the topic detection job. The default is 10.
-
dataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.
-
volumeKmsKeyId
ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
- Returns:
- ID for the Amazon Web Services Key Management Service (KMS) key that Amazon Comprehend uses to encrypt
data on the storage volume attached to the ML compute instance(s) that process the analysis job. The
VolumeKmsKeyId can be either of the following formats:
-
KMS Key ID:
"1234abcd-12ab-34cd-56ef-1234567890ab"
-
Amazon Resource Name (ARN) of a KMS Key:
"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
-
-
-
vpcConfig
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
- Returns:
- Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
-
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<TopicsDetectionJobProperties.Builder,
TopicsDetectionJobProperties> - 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
-