software.amazon.awssdk.services.comprehend.model

Interface TopicsDetectionJobProperties.Builder

All Superinterfaces:

CopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>, SdkBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>

Enclosing class:

TopicsDetectionJobProperties

public static interface TopicsDetectionJobProperties.Builder
extends CopyableBuilder<TopicsDetectionJobProperties.Builder,TopicsDetectionJobProperties>

Method Summary

Modifier and Type	Method and Description
TopicsDetectionJobProperties.Builder	endTime(Instant endTime) The time that the topic detection job was completed.
default TopicsDetectionJobProperties.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input data configuration supplied when you created the topic detection job.
TopicsDetectionJobProperties.Builder	inputDataConfig(InputDataConfig inputDataConfig) The input data configuration supplied when you created the topic detection job.
TopicsDetectionJobProperties.Builder	jobId(String jobId) The identifier assigned to the topic detection job.
TopicsDetectionJobProperties.Builder	jobName(String jobName) The name of the topic detection job.
TopicsDetectionJobProperties.Builder	jobStatus(JobStatus jobStatus) The current status of the topic detection job.
TopicsDetectionJobProperties.Builder	jobStatus(String jobStatus) The current status of the topic detection job.
TopicsDetectionJobProperties.Builder	message(String message) A description for the status of a job.
TopicsDetectionJobProperties.Builder	numberOfTopics(Integer numberOfTopics) The number of topics to detect supplied when you created the topic detection job.
default TopicsDetectionJobProperties.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output data configuration supplied when you created the topic detection job.
TopicsDetectionJobProperties.Builder	outputDataConfig(OutputDataConfig outputDataConfig) The output data configuration supplied when you created the topic detection job.
TopicsDetectionJobProperties.Builder	submitTime(Instant submitTime) The time that the topic detection job was submitted for processing.

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

copy

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

apply, build

Method Detail

jobId

TopicsDetectionJobProperties.Builder jobId(String jobId)

The identifier assigned to the topic detection job.

Parameters:

jobId - The identifier assigned to the topic detection job.

Returns:

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

jobName

TopicsDetectionJobProperties.Builder jobName(String jobName)

The name of the topic detection job.

Parameters:

jobName - The name of the topic detection job.

Returns:

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

jobStatus

TopicsDetectionJobProperties.Builder jobStatus(String jobStatus)

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Parameters:

jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Returns:

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

See Also:

JobStatus, JobStatus

jobStatus

TopicsDetectionJobProperties.Builder jobStatus(JobStatus jobStatus)

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Parameters:

jobStatus - The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

Returns:

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

See Also:

JobStatus, JobStatus

message

TopicsDetectionJobProperties.Builder message(String message)

A description for the status of a job.

Parameters:

message - A description for the status of a job.

Returns:

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

submitTime

TopicsDetectionJobProperties.Builder submitTime(Instant submitTime)

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

Parameters:

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

Returns:

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

endTime

TopicsDetectionJobProperties.Builder endTime(Instant endTime)

The time that the topic detection job was completed.

Parameters:

endTime - The time that the topic detection job was completed.

Returns:

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

inputDataConfig

TopicsDetectionJobProperties.Builder inputDataConfig(InputDataConfig inputDataConfig)

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

Parameters:

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

Returns:

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

inputDataConfig

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

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

TopicsDetectionJobProperties.Builder outputDataConfig(OutputDataConfig outputDataConfig)

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

Parameters:

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

Returns:

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

outputDataConfig

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

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

numberOfTopics

TopicsDetectionJobProperties.Builder numberOfTopics(Integer numberOfTopics)

The number of topics to detect supplied when you created the topic detection job. The default is 10.

Parameters:

numberOfTopics - The number of topics to detect supplied when you created the topic detection job. The default is 10.

Returns:

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