Interface StartKeyPhrasesDetectionJobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ComprehendRequest.Builder
,CopyableBuilder<StartKeyPhrasesDetectionJobRequest.Builder,
,StartKeyPhrasesDetectionJobRequest> SdkBuilder<StartKeyPhrasesDetectionJobRequest.Builder,
,StartKeyPhrasesDetectionJobRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartKeyPhrasesDetectionJobRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken
(String clientRequestToken) A unique identifier for the request.dataAccessRoleArn
(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.inputDataConfig
(Consumer<InputDataConfig.Builder> inputDataConfig) Specifies the format and location of the input data for the job.inputDataConfig
(InputDataConfig inputDataConfig) Specifies the format and location of the input data for the job.The identifier of the job.languageCode
(String languageCode) The language of the input documents.languageCode
(LanguageCode languageCode) The language of the input documents.outputDataConfig
(Consumer<OutputDataConfig.Builder> outputDataConfig) Specifies where to send the output files.outputDataConfig
(OutputDataConfig outputDataConfig) Specifies where to send the output files.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) Tags to associate with the key phrases detection job.tags
(Consumer<Tag.Builder>... tags) Tags to associate with the key phrases detection job.Tags to associate with the key phrases detection job.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.vpcConfig
(Consumer<VpcConfig.Builder> vpcConfig) Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job.Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job.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
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 StartKeyPhrasesDetectionJobRequest.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 theInputDataConfig.Builder
avoiding the need to create one manually viaInputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputDataConfig(InputDataConfig)
.- Parameters:
inputDataConfig
- a consumer that will call methods onInputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 StartKeyPhrasesDetectionJobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) Specifies where to send the output files.
This is a convenience method that creates an instance of theOutputDataConfig.Builder
avoiding the need to create one manually viaOutputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputDataConfig(OutputDataConfig)
.- Parameters:
outputDataConfig
- a consumer that will call methods onOutputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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
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:
-
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
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
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases 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 key phrases detection job. For more information, see Amazon VPC.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
vpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
This is a convenience method that creates an instance of theVpcConfig.Builder
avoiding the need to create one manually viaVpcConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovpcConfig(VpcConfig)
.- Parameters:
vpcConfig
- a consumer that will call methods onVpcConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Tags to associate with the key phrases 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 key phrases 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
Tags to associate with the key phrases 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 key phrases 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
Tags to associate with the key phrases 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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartKeyPhrasesDetectionJobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartKeyPhrasesDetectionJobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-