Package software.amazon.awssdk.services.comprehend.model

Interface TopicsDetectionJobProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>, SdkBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>, SdkPojo
Enclosing class:
TopicsDetectionJobProperties
public static interface TopicsDetectionJobProperties.Builder extends SdkPojo, CopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>

  • Method Details

    • jobId

      TopicsDetectionJobProperties.Builder jobId(String jobId)

      The identifier assigned to the topic detection job.

      Parameters:
      jobId - The identifier assigned to the topic detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobArn

      TopicsDetectionJobProperties.Builder jobArn(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • jobName

      TopicsDetectionJobProperties.Builder jobName(String jobName)

      The name of the topic detection job.

      Parameters:
      jobName - The name of the topic detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobStatus

      TopicsDetectionJobProperties.Builder jobStatus(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobStatus

      TopicsDetectionJobProperties.Builder jobStatus(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • message

      TopicsDetectionJobProperties.Builder message(String message)

      A description for the status of a job.

      Parameters:
      message - A description for the status of a job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • submitTime

      TopicsDetectionJobProperties.Builder submitTime(Instant submitTime)

      The time that the topic detection job was submitted for processing.

      Parameters:
      submitTime - The time that the topic detection job was submitted for processing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      TopicsDetectionJobProperties.Builder endTime(Instant endTime)

      The time that the topic detection job was completed.

      Parameters:
      endTime - The time that the topic detection job was completed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      TopicsDetectionJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

      The input data configuration supplied when you created the topic detection job.

      Parameters:
      inputDataConfig - The input data configuration supplied when you created the topic detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • inputDataConfig

      default TopicsDetectionJobProperties.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

      The input data configuration supplied when you created the topic detection job.

      This is a convenience method that creates an instance of the InputDataConfig.Builder avoiding the need to create one manually via InputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(InputDataConfig).

      Parameters:
      inputDataConfig - a consumer that will call methods on InputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputDataConfig

      TopicsDetectionJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

      The output data configuration supplied when you created the topic detection job.

      Parameters:
      outputDataConfig - The output data configuration supplied when you created the topic detection job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputDataConfig

      default TopicsDetectionJobProperties.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

      The output data configuration supplied when you created the topic detection job.

      This is a convenience method that creates an instance of the OutputDataConfig.Builder avoiding the need to create one manually via OutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(OutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on OutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfTopics

      TopicsDetectionJobProperties.Builder numberOfTopics(Integer numberOfTopics)

      The number of topics to detect supplied when you created the topic detection job. The default is 10.

      Parameters:
      numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataAccessRoleArn

      TopicsDetectionJobProperties.Builder dataAccessRoleArn(String dataAccessRoleArn)

      The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.

      Parameters:
      dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your job data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeKmsKeyId

      TopicsDetectionJobProperties.Builder volumeKmsKeyId(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"

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      TopicsDetectionJobProperties.Builder vpcConfig(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • vpcConfig

      default TopicsDetectionJobProperties.Builder vpcConfig(Consumer<VpcConfig.Builder> 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.

      This is a convenience method that creates an instance of the VpcConfig.Builder avoiding the need to create one manually via VpcConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfig(VpcConfig).

      Parameters:
      vpcConfig - a consumer that will call methods on VpcConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: