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) that gives 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.
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	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.

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

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.

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 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 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) that gives Amazon Comprehend read access to your input data.

Parameters:

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

Returns:

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