software.amazon.awssdk.services.comprehend.model

Interface StartSentimentDetectionJobRequest.Builder

All Superinterfaces:

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

Enclosing class:

StartSentimentDetectionJobRequest

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

Method Summary

Modifier and Type	Method and Description
StartSentimentDetectionJobRequest.Builder	clientRequestToken(String clientRequestToken) A unique identifier for the request.
StartSentimentDetectionJobRequest.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.
default StartSentimentDetectionJobRequest.Builder	inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) Specifies the format and location of the input data for the job.
StartSentimentDetectionJobRequest.Builder	inputDataConfig(InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.
StartSentimentDetectionJobRequest.Builder	jobName(String jobName) The identifier of the job.
StartSentimentDetectionJobRequest.Builder	languageCode(LanguageCode languageCode) The language of the input documents.
StartSentimentDetectionJobRequest.Builder	languageCode(String languageCode) The language of the input documents.
default StartSentimentDetectionJobRequest.Builder	outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) Specifies where to send the output files.
StartSentimentDetectionJobRequest.Builder	outputDataConfig(OutputDataConfig outputDataConfig) Specifies where to send the output files.
StartSentimentDetectionJobRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartSentimentDetectionJobRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
StartSentimentDetectionJobRequest.Builder	volumeKmsKeyId(String volumeKmsKeyId) ID for the AWS 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 StartSentimentDetectionJobRequest.Builder	vpcConfig(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job.
StartSentimentDetectionJobRequest.Builder	vpcConfig(VpcConfig vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment 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

StartSentimentDetectionJobRequest.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 StartSentimentDetectionJobRequest.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

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

StartSentimentDetectionJobRequest.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 StartSentimentDetectionJobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig)

Specifies where to send the output files.

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

StartSentimentDetectionJobRequest.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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role- permissions.

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. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role- permissions.

Returns:

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

jobName

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

StartSentimentDetectionJobRequest.Builder languageCode(String languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

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

See Also:

LanguageCode, LanguageCode

languageCode

StartSentimentDetectionJobRequest.Builder languageCode(LanguageCode languageCode)

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Parameters:

languageCode - The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

Returns:

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

See Also:

LanguageCode, LanguageCode

clientRequestToken

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

StartSentimentDetectionJobRequest.Builder volumeKmsKeyId(String volumeKmsKeyId)

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

StartSentimentDetectionJobRequest.Builder vpcConfig(VpcConfig vpcConfig)

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

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

This is a convenience 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)

overrideConfiguration

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

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