software.amazon.awssdk.services.comprehend.model

Interface EntitiesDetectionJobProperties.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>, SdkBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>, SdkPojo

Enclosing class:

EntitiesDetectionJobProperties

public static interface EntitiesDetectionJobProperties.Builder
extends SdkPojo, CopyableBuilder<EntitiesDetectionJobProperties.Builder,EntitiesDetectionJobProperties>

Method Summary

Modifier and Type	Method and Description
EntitiesDetectionJobProperties.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
EntitiesDetectionJobProperties.Builder	endTime(Instant endTime) The time that the entities detection job completed
EntitiesDetectionJobProperties.Builder	entityRecognizerArn(String entityRecognizerArn) The Amazon Resource Name (ARN) that identifies the entity recognizer.
EntitiesDetectionJobProperties.Builder	flywheelArn(String flywheelArn) The Amazon Resource Name (ARN) of the flywheel associated with this job.
default EntitiesDetectionJobProperties.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data configuration that you supplied when you created the entities detection job.
EntitiesDetectionJobProperties.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input data configuration that you supplied when you created the entities detection job.
EntitiesDetectionJobProperties.Builder	jobArn(String jobArn) The Amazon Resource Name (ARN) of the entities detection job.
EntitiesDetectionJobProperties.Builder	jobId(String jobId) The identifier assigned to the entities detection job.
EntitiesDetectionJobProperties.Builder	jobName(String jobName) The name that you assigned the entities detection job.
EntitiesDetectionJobProperties.Builder	jobStatus(JobStatus jobStatus) The current status of the entities detection job.
EntitiesDetectionJobProperties.Builder	jobStatus(String jobStatus) The current status of the entities detection job.
EntitiesDetectionJobProperties.Builder	languageCode(LanguageCode languageCode) The language code of the input documents.
EntitiesDetectionJobProperties.Builder	languageCode(String languageCode) The language code of the input documents.
EntitiesDetectionJobProperties.Builder	message(String message) A description of the status of a job.
default EntitiesDetectionJobProperties.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data configuration that you supplied when you created the entities detection job.
EntitiesDetectionJobProperties.Builder	outputDataConfig(OutputDataConfig outputDataConfig) The output data configuration that you supplied when you created the entities detection job.
EntitiesDetectionJobProperties.Builder	submitTime(Instant submitTime) The time that the entities detection job was submitted for processing.
EntitiesDetectionJobProperties.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.
default EntitiesDetectionJobProperties.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.
EntitiesDetectionJobProperties.Builder	vpcConfig(VpcConfig vpcConfig) Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

jobId

EntitiesDetectionJobProperties.Builder jobId(String jobId)

The identifier assigned to the entities detection job.

Parameters:

jobId - The identifier assigned to the entities detection job.

Returns:

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

jobArn

EntitiesDetectionJobProperties.Builder jobArn(String jobArn)

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

The following is an example job ARN:

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

Parameters:

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

The following is an example job ARN:

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

Returns:

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

jobName

EntitiesDetectionJobProperties.Builder jobName(String jobName)

The name that you assigned the entities detection job.

Parameters:

jobName - The name that you assigned the entities detection job.

Returns:

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

jobStatus

EntitiesDetectionJobProperties.Builder jobStatus(String jobStatus)

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

Parameters:

jobStatus - The current status of the entities 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

EntitiesDetectionJobProperties.Builder jobStatus(JobStatus jobStatus)

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

Parameters:

jobStatus - The current status of the entities 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

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

EntitiesDetectionJobProperties.Builder submitTime(Instant submitTime)

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

Parameters:

submitTime - The time that the entities detection job was submitted for processing.

Returns:

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

endTime

EntitiesDetectionJobProperties.Builder endTime(Instant endTime)

The time that the entities detection job completed

Parameters:

endTime - The time that the entities detection job completed

Returns:

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

entityRecognizerArn

EntitiesDetectionJobProperties.Builder entityRecognizerArn(String entityRecognizerArn)

The Amazon Resource Name (ARN) that identifies the entity recognizer.

Parameters:

entityRecognizerArn - The Amazon Resource Name (ARN) that identifies the entity recognizer.

Returns:

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

inputDataConfig

EntitiesDetectionJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

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

Parameters:

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

Returns:

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

inputDataConfig

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

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

inputDataConfig(InputDataConfig)

outputDataConfig

EntitiesDetectionJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

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

Parameters:

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

Returns:

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

outputDataConfig

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

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

outputDataConfig(OutputDataConfig)

languageCode

EntitiesDetectionJobProperties.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, LanguageCode

languageCode

EntitiesDetectionJobProperties.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:

LanguageCode, LanguageCode

dataAccessRoleArn

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

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

EntitiesDetectionJobProperties.Builder vpcConfig(VpcConfig vpcConfig)

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

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

vpcConfig(VpcConfig)

flywheelArn

EntitiesDetectionJobProperties.Builder flywheelArn(String flywheelArn)

The Amazon Resource Name (ARN) of the flywheel associated with this job.

Parameters:

flywheelArn - The Amazon Resource Name (ARN) of the flywheel associated with this job.

Returns:

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