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

Interface TargetedSentimentDetectionJobProperties.Builder

    • Method Detail

      • jobId

        TargetedSentimentDetectionJobProperties.Builder jobId​(String jobId)

        The identifier assigned to the targeted sentiment detection job.

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

      • jobArn

        TargetedSentimentDetectionJobProperties.Builder jobArn​(String jobArn)

        The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        Parameters:
        jobArn - The Amazon Resource Name (ARN) of the targeted sentiment 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>:targeted-sentiment-detection-job/<job-id>

        The following is an example job ARN:

        arn:aws:comprehend:us-west-2:111122223333:targeted-sentiment-detection-job/1234abcd12ab34cd56ef1234567890ab

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • jobName

        TargetedSentimentDetectionJobProperties.Builder jobName​(String jobName)

        The name that you assigned to the targeted sentiment detection job.

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

      • jobStatus

        TargetedSentimentDetectionJobProperties.Builder jobStatus​(String jobStatus)

        The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

        Parameters:
        jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • jobStatus

        TargetedSentimentDetectionJobProperties.Builder jobStatus​(JobStatus jobStatus)

        The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

        Parameters:
        jobStatus - The current status of the targeted sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        JobStatus, JobStatus

      • message

        TargetedSentimentDetectionJobProperties.Builder message​(String message)

        A description of the status of a job.

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

      • submitTime

        TargetedSentimentDetectionJobProperties.Builder submitTime​(Instant submitTime)

        The time that the targeted sentiment detection job was submitted for processing.

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

      • endTime

        TargetedSentimentDetectionJobProperties.Builder endTime​(Instant endTime)

        The time that the targeted sentiment detection job ended.

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

      • inputDataConfig

        TargetedSentimentDetectionJobProperties.Builder inputDataConfig​(InputDataConfig inputDataConfig)
        Sets the value of the InputDataConfig property for this object.
        Parameters:
        inputDataConfig - The new value for the InputDataConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputDataConfig

        TargetedSentimentDetectionJobProperties.Builder outputDataConfig​(OutputDataConfig outputDataConfig)
        Sets the value of the OutputDataConfig property for this object.
        Parameters:
        outputDataConfig - The new value for the OutputDataConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dataAccessRoleArn

        TargetedSentimentDetectionJobProperties.Builder dataAccessRoleArn​(String dataAccessRoleArn)

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

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

      • volumeKmsKeyId

        TargetedSentimentDetectionJobProperties.Builder volumeKmsKeyId​(String volumeKmsKeyId)

        ID for the KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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 KMS key that Amazon Comprehend uses to encrypt the data on the storage volume attached to the ML compute instance(s) that process the targeted sentiment detection 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

        TargetedSentimentDetectionJobProperties.Builder vpcConfig​(VpcConfig vpcConfig)
        Sets the value of the VpcConfig property for this object.
        Parameters:
        vpcConfig - The new value for the VpcConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.