Class TopicsDetectionJobProperties

java.lang.Object
software.amazon.awssdk.services.comprehend.model.TopicsDetectionJobProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>
@Generated("software.amazon.awssdk:codegen") public final class TopicsDetectionJobProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>

Provides information about a topic detection job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The identifier assigned to the topic detection job.

      Returns:
      The identifier assigned to the topic detection job.

    • jobArn

      public final String 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

      public final String jobName()

      The name of the topic detection job.

      Returns:
      The name of the topic detection job.

    • jobStatus

      public final JobStatus jobStatus()

      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

      If the service returns an enum value that is not available in the current SDK version, jobStatus will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from jobStatusAsString().

      Returns:
      The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.
      See Also:

    • message

      public final String message()

      A description for the status of a job.

      Returns:
      A description for the status of a job.

    • submitTime

      public final Instant 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

      public final Instant endTime()

      The time that the topic detection job was completed.

      Returns:
      The time that the topic detection job was completed.

    • inputDataConfig

      public final InputDataConfig 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

      public final OutputDataConfig 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

      public final Integer 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

      public final String 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

      public final String 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

      public final VpcConfig 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

      public TopicsDetectionJobProperties.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<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>
      Returns:
      a builder for type T

    • builder

      public static TopicsDetectionJobProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TopicsDetectionJobProperties.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.