software.amazon.awssdk.services.comprehend.model

Interface StartTopicsDetectionJobRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ComprehendRequest.Builder, CopyableBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>, SdkBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartTopicsDetectionJobRequest

public static interface StartTopicsDetectionJobRequest.Builder
extends ComprehendRequest.Builder, SdkPojo, CopyableBuilder<StartTopicsDetectionJobRequest.Builder,StartTopicsDetectionJobRequest>

Method Summary

Modifier and Type	Method and Description
StartTopicsDetectionJobRequest.Builder	clientRequestToken(String clientRequestToken) A unique identifier for the request.
StartTopicsDetectionJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
default StartTopicsDetectionJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) Specifies the format and location of the input data for the job.
StartTopicsDetectionJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
StartTopicsDetectionJobRequest.Builder	jobName(String jobName) The identifier of the job.
StartTopicsDetectionJobRequest.Builder	numberOfTopics(Integer numberOfTopics) The number of topics to detect.
default StartTopicsDetectionJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) Specifies where to send the output files.
StartTopicsDetectionJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
StartTopicsDetectionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartTopicsDetectionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartTopicsDetectionJobRequest.Builder	tags(Collection<Tag> tags) Tags to associate with the topics detection job.
StartTopicsDetectionJobRequest.Builder	tags(Consumer<Tag.Builder>... tags) Tags to associate with the topics detection job.
StartTopicsDetectionJobRequest.Builder	tags(Tag... tags) Tags to associate with the topics detection job.
StartTopicsDetectionJobRequest.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 StartTopicsDetectionJobRequest.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.
StartTopicsDetectionJobRequest.Builder	vpcConfig(VpcConfig vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job.

Methods inherited from interface software.amazon.awssdk.services.comprehend.model.ComprehendRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

inputDataConfig

StartTopicsDetectionJobRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

Specifies the format and location of the input data for the job.

Parameters:

inputDataConfig - Specifies the format and location of the input data for the job.

Returns:

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

inputDataConfig

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

Specifies the format and location of the input data for the 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

StartTopicsDetectionJobRequest.Builder outputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Parameters:

outputDataConfig - Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

Returns:

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

outputDataConfig

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

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

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)

dataAccessRoleArn

StartTopicsDetectionJobRequest.Builder dataAccessRoleArn(String dataAccessRoleArn)

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Parameters:

dataAccessRoleArn - The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data. For more information, see Role-based permissions.

Returns:

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

jobName

StartTopicsDetectionJobRequest.Builder jobName(String jobName)

The identifier of the job.

Parameters:

jobName - The identifier of the job.

Returns:

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

numberOfTopics

StartTopicsDetectionJobRequest.Builder numberOfTopics(Integer numberOfTopics)

The number of topics to detect.

Parameters:

numberOfTopics - The number of topics to detect.

Returns:

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

clientRequestToken

StartTopicsDetectionJobRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Parameters:

clientRequestToken - A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

Returns:

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

volumeKmsKeyId

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

StartTopicsDetectionJobRequest.Builder vpcConfig(VpcConfig vpcConfig)

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.

Parameters:

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

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

tags

StartTopicsDetectionJobRequest.Builder tags(Collection<Tag> tags)

Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

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

tags

StartTopicsDetectionJobRequest.Builder tags(Tag... tags)

Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Parameters:

tags - Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

Returns:

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

tags

StartTopicsDetectionJobRequest.Builder tags(Consumer<Tag.Builder>... tags)

Tags to associate with the topics detection job. A tag is a key-value pair that adds metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

overrideConfiguration

StartTopicsDetectionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartTopicsDetectionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder