software.amazon.awssdk.services.comprehend.model

Interface DocumentClassificationJobProperties.Builder

All Superinterfaces:

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

Enclosing class:

DocumentClassificationJobProperties

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

Method Summary

Modifier and Type	Method and Description
DocumentClassificationJobProperties.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.
DocumentClassificationJobProperties.Builder	documentClassifierArn(String documentClassifierArn) The Amazon Resource Name (ARN) that identifies the document classifier.
DocumentClassificationJobProperties.Builder	endTime(Instant endTime) The time that the document classification job completed.
default DocumentClassificationJobProperties.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data configuration that you supplied when you created the document classification job.
DocumentClassificationJobProperties.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input data configuration that you supplied when you created the document classification job.
DocumentClassificationJobProperties.Builder	jobId(String jobId) The identifier assigned to the document classification job.
DocumentClassificationJobProperties.Builder	jobName(String jobName) The name that you assigned to the document classification job.
DocumentClassificationJobProperties.Builder	jobStatus(JobStatus jobStatus) The current status of the document classification job.
DocumentClassificationJobProperties.Builder	jobStatus(String jobStatus) The current status of the document classification job.
DocumentClassificationJobProperties.Builder	message(String message) A description of the status of the job.
default DocumentClassificationJobProperties.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data configuration that you supplied when you created the document classification job.
DocumentClassificationJobProperties.Builder	outputDataConfig(OutputDataConfig outputDataConfig) The output data configuration that you supplied when you created the document classification job.
DocumentClassificationJobProperties.Builder	submitTime(Instant submitTime) The time that the document classification 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

DocumentClassificationJobProperties.Builder jobId(String jobId)

The identifier assigned to the document classification job.

Parameters:

jobId - The identifier assigned to the document classification job.

Returns:

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

jobName

DocumentClassificationJobProperties.Builder jobName(String jobName)

The name that you assigned to the document classification job.

Parameters:

jobName - The name that you assigned to the document classification job.

Returns:

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

jobStatus

DocumentClassificationJobProperties.Builder jobStatus(String jobStatus)

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

Parameters:

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

DocumentClassificationJobProperties.Builder jobStatus(JobStatus jobStatus)

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

Parameters:

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

DocumentClassificationJobProperties.Builder message(String message)

A description of the status of the job.

Parameters:

message - A description of the status of the job.

Returns:

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

submitTime

DocumentClassificationJobProperties.Builder submitTime(Instant submitTime)

The time that the document classification job was submitted for processing.

Parameters:

submitTime - The time that the document classification job was submitted for processing.

Returns:

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

endTime

DocumentClassificationJobProperties.Builder endTime(Instant endTime)

The time that the document classification job completed.

Parameters:

endTime - The time that the document classification job completed.

Returns:

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

documentClassifierArn

DocumentClassificationJobProperties.Builder documentClassifierArn(String documentClassifierArn)

The Amazon Resource Name (ARN) that identifies the document classifier.

Parameters:

documentClassifierArn - The Amazon Resource Name (ARN) that identifies the document classifier.

Returns:

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

inputDataConfig

DocumentClassificationJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

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

Parameters:

inputDataConfig - The input data configuration that you supplied when you created the document classification job.

Returns:

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

inputDataConfig

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

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

DocumentClassificationJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

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

Parameters:

outputDataConfig - The output data configuration that you supplied when you created the document classification job.

Returns:

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

outputDataConfig

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

The output data configuration that you supplied when you created the document classification 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)

dataAccessRoleArn

DocumentClassificationJobProperties.Builder dataAccessRoleArn(String dataAccessRoleArn)

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

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the AWS identity and Access Management (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.