Package software.amazon.awssdk.services.comprehendmedical.model

Interface ComprehendMedicalAsyncJobProperties.Builder

    • Method Detail

      • jobId

        ComprehendMedicalAsyncJobProperties.Builder jobId​(String jobId)

        The identifier assigned to the detection job.

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

      • jobName

        ComprehendMedicalAsyncJobProperties.Builder jobName​(String jobName)

        The name that you assigned to the detection job.

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

      • jobStatus

        ComprehendMedicalAsyncJobProperties.Builder jobStatus​(String jobStatus)

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

        Parameters:
        jobStatus - The current status of the detection job. If the status is FAILED, the Message 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

        ComprehendMedicalAsyncJobProperties.Builder jobStatus​(JobStatus jobStatus)

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

        Parameters:
        jobStatus - The current status of the detection job. If the status is FAILED, the Message 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

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

        ComprehendMedicalAsyncJobProperties.Builder submitTime​(Instant submitTime)

        The time that the detection job was submitted for processing.

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

      • endTime

        ComprehendMedicalAsyncJobProperties.Builder endTime​(Instant endTime)

        The time that the detection job completed.

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

      • expirationTime

        ComprehendMedicalAsyncJobProperties.Builder expirationTime​(Instant expirationTime)

        The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.

        Parameters:
        expirationTime - The date and time that job metadata is deleted from the server. Output files in your S3 bucket will not be deleted. After the metadata is deleted, the job will no longer appear in the results of the ListEntitiesDetectionV2Job or the ListPHIDetectionJobs operation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputDataConfig

        ComprehendMedicalAsyncJobProperties.Builder inputDataConfig​(InputDataConfig inputDataConfig)

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

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

      • outputDataConfig

        ComprehendMedicalAsyncJobProperties.Builder outputDataConfig​(OutputDataConfig outputDataConfig)

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

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

      • dataAccessRoleArn

        ComprehendMedicalAsyncJobProperties.Builder dataAccessRoleArn​(String dataAccessRoleArn)

        The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical read access to your input data.

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

      • manifestFilePath

        ComprehendMedicalAsyncJobProperties.Builder manifestFilePath​(String manifestFilePath)

        The path to the file that describes the results of a batch job.

        Parameters:
        manifestFilePath - The path to the file that describes the results of a batch job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKey

        ComprehendMedicalAsyncJobProperties.Builder kmsKey​(String kmsKey)

        The AWS Key Management Service key, if any, used to encrypt the output files.

        Parameters:
        kmsKey - The AWS Key Management Service key, if any, used to encrypt the output files.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • modelVersion

        ComprehendMedicalAsyncJobProperties.Builder modelVersion​(String modelVersion)

        The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.

        Parameters:
        modelVersion - The version of the model used to analyze the documents. The version number looks like X.X.X. You can use this information to track the model used for a particular batch of documents.
        Returns:
        Returns a reference to this object so that method calls can be chained together.