Package software.amazon.awssdk.services.comprehend.model

Interface StartTargetedSentimentDetectionJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartTargetedSentimentDetectionJobRequest

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

Method Summary

Modifier and Type	Method	Description
StartTargetedSentimentDetectionJobRequest.Builder	clientRequestToken(String clientRequestToken)	A unique identifier for the request.
StartTargetedSentimentDetectionJobRequest.Builder	dataAccessRoleArn(String dataAccessRoleArn)	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
default StartTargetedSentimentDetectionJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)	Sets the value of the InputDataConfig property for this object.
StartTargetedSentimentDetectionJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig)	Sets the value of the InputDataConfig property for this object.
StartTargetedSentimentDetectionJobRequest.Builder	jobName(String jobName)	The identifier of the job.
StartTargetedSentimentDetectionJobRequest.Builder	languageCode(String languageCode)	The language of the input documents.
StartTargetedSentimentDetectionJobRequest.Builder	languageCode(LanguageCode languageCode)	The language of the input documents.
default StartTargetedSentimentDetectionJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)	Specifies where to send the output files.
StartTargetedSentimentDetectionJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig)	Specifies where to send the output files.
StartTargetedSentimentDetectionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartTargetedSentimentDetectionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartTargetedSentimentDetectionJobRequest.Builder	tags(Collection<Tag> tags)	Tags to associate with the targeted sentiment detection job.
StartTargetedSentimentDetectionJobRequest.Builder	tags(Consumer<Tag.Builder>... tags)	Tags to associate with the targeted sentiment detection job.
StartTargetedSentimentDetectionJobRequest.Builder	tags(Tag... tags)	Tags to associate with the targeted sentiment detection job.
StartTargetedSentimentDetectionJobRequest.Builder	volumeKmsKeyId(String volumeKmsKeyId)	ID for the 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 StartTargetedSentimentDetectionJobRequest.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)	Sets the value of the VpcConfig property for this object.
StartTargetedSentimentDetectionJobRequest.Builder	vpcConfig(VpcConfig vpcConfig)	Sets the value of the VpcConfig property for this object.

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

overrideConfiguration

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

build

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

inputDataConfig

StartTargetedSentimentDetectionJobRequest.Builder inputDataConfig(InputDataConfig inputDataConfig)

Sets the value of the InputDataConfig property for this object.

Parameters:

inputDataConfig - The new value for the InputDataConfig property for this object.

Returns:

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

inputDataConfig

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

Sets the value of the InputDataConfig property for this object. 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

StartTargetedSentimentDetectionJobRequest.Builder outputDataConfig(OutputDataConfig outputDataConfig)

Specifies where to send the output files.

Parameters:

outputDataConfig - Specifies where to send the output files.

Returns:

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

outputDataConfig

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

Specifies where to send the output files.

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

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

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

languageCode

StartTargetedSentimentDetectionJobRequest.Builder languageCode(String languageCode)

The language of the input documents. Currently, English is the only supported language.

Parameters:

languageCode - The language of the input documents. Currently, English is the only supported language.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

languageCode

StartTargetedSentimentDetectionJobRequest.Builder languageCode(LanguageCode languageCode)

The language of the input documents. Currently, English is the only supported language.

Parameters:

languageCode - The language of the input documents. Currently, English is the only supported language.

Returns:

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

See Also:

• LanguageCode
• LanguageCode

clientRequestToken

StartTargetedSentimentDetectionJobRequest.Builder clientRequestToken(String clientRequestToken)

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Parameters:

clientRequestToken - A unique identifier for the request. If you don't 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

StartTargetedSentimentDetectionJobRequest.Builder volumeKmsKeyId(String volumeKmsKeyId)

ID for the 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 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

StartTargetedSentimentDetectionJobRequest.Builder vpcConfig(VpcConfig vpcConfig)

Sets the value of the VpcConfig property for this object.

Parameters:

vpcConfig - The new value for the VpcConfig property for this object.

Returns:

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

vpcConfig

default StartTargetedSentimentDetectionJobRequest.Builder vpcConfig(Consumer<VpcConfig.Builder> vpcConfig)

Sets the value of the VpcConfig property for this object. 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

StartTargetedSentimentDetectionJobRequest.Builder tags(Collection<Tag> tags)

Tags to associate with the targeted sentiment 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 targeted sentiment 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

StartTargetedSentimentDetectionJobRequest.Builder tags(Tag... tags)

Tags to associate with the targeted sentiment 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 targeted sentiment 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

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

Tags to associate with the targeted sentiment 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<Tag>).

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<Tag>)

overrideConfiguration

StartTargetedSentimentDetectionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

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

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.