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

Interface KeyPhrasesDetectionJobProperties.Builder

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

  • Method Details

    • jobId

      KeyPhrasesDetectionJobProperties.Builder jobId(String jobId)

      The identifier assigned to the key phrases detection job.

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

    • jobArn

      KeyPhrasesDetectionJobProperties.Builder jobArn(String jobArn)

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

      The following is an example job ARN:

      arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

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

      The following is an example job ARN:

      arn:aws:comprehend:us-west-2:111122223333:key-phrases-detection-job/1234abcd12ab34cd56ef1234567890ab

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

    • jobName

      KeyPhrasesDetectionJobProperties.Builder jobName(String jobName)

      The name that you assigned the key phrases detection job.

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

    • jobStatus

      KeyPhrasesDetectionJobProperties.Builder jobStatus(String jobStatus)

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

      Parameters:
      jobStatus - The current status of the key phrases 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

      KeyPhrasesDetectionJobProperties.Builder jobStatus(JobStatus jobStatus)

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

      Parameters:
      jobStatus - The current status of the key phrases 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:

    • message

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

      KeyPhrasesDetectionJobProperties.Builder submitTime(Instant submitTime)

      The time that the key phrases detection job was submitted for processing.

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

    • endTime

      KeyPhrasesDetectionJobProperties.Builder endTime(Instant endTime)

      The time that the key phrases detection job completed.

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

    • inputDataConfig

      KeyPhrasesDetectionJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

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

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

    • inputDataConfig

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

      The input data configuration that you supplied when you created the key phrases 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

      KeyPhrasesDetectionJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

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

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

    • outputDataConfig

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

      The output data configuration that you supplied when you created the key phrases 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:

    • languageCode

      KeyPhrasesDetectionJobProperties.Builder languageCode(String languageCode)

      The language code of the input documents.

      Parameters:
      languageCode - The language code of the input documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • languageCode

      KeyPhrasesDetectionJobProperties.Builder languageCode(LanguageCode languageCode)

      The language code of the input documents.

      Parameters:
      languageCode - The language code of the input documents.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataAccessRoleArn

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

      KeyPhrasesDetectionJobProperties.Builder volumeKmsKeyId(String volumeKmsKeyId)

      ID for the 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 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

      KeyPhrasesDetectionJobProperties.Builder vpcConfig(VpcConfig vpcConfig)

      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases 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 key phrases 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 KeyPhrasesDetectionJobProperties.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

      Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases 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: