Interface StartEntitiesDetectionV2JobRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,ComprehendMedicalRequest.Builder,CopyableBuilder<StartEntitiesDetectionV2JobRequest.Builder,,StartEntitiesDetectionV2JobRequest> SdkBuilder<StartEntitiesDetectionV2JobRequest.Builder,,StartEntitiesDetectionV2JobRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
StartEntitiesDetectionV2JobRequest
public static interface StartEntitiesDetectionV2JobRequest.Builder
extends ComprehendMedicalRequest.Builder, SdkPojo, CopyableBuilder<StartEntitiesDetectionV2JobRequest.Builder,StartEntitiesDetectionV2JobRequest>
-
Method Summary
Modifier and TypeMethodDescriptionclientRequestToken(String clientRequestToken) A unique identifier for the request.dataAccessRoleArn(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input configuration that specifies the format and location of the input data for the job.inputDataConfig(InputDataConfig inputDataConfig) The input configuration that specifies the format and location of the input data for the job.The identifier of the job.An AWS Key Management Service key to encrypt your output files.languageCode(String languageCode) The language of the input documents.languageCode(LanguageCode languageCode) The language of the input documents.outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output configuration that specifies where to send the output files.outputDataConfig(OutputDataConfig outputDataConfig) The output configuration that 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.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.services.comprehendmedical.model.ComprehendMedicalRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
inputDataConfig
The input configuration that specifies the format and location of the input data for the job.
- Parameters:
inputDataConfig- The input configuration that 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 StartEntitiesDetectionV2JobRequest.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig) The input configuration that specifies the format and location of the input data for the job.
This is a convenience method that creates an instance of theInputDataConfig.Builderavoiding the need to create one manually viaInputDataConfig.builder().When the
Consumercompletes,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
The output configuration that specifies where to send the output files.
- Parameters:
outputDataConfig- The output configuration that specifies where to send the output files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
default StartEntitiesDetectionV2JobRequest.Builder outputDataConfig(Consumer<OutputDataConfig.Builder> outputDataConfig) The output configuration that specifies where to send the output files.
This is a convenience method that creates an instance of theOutputDataConfig.Builderavoiding the need to create one manually viaOutputDataConfig.builder().When the
Consumercompletes,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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
- Parameters:
dataAccessRoleArn- The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.- 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.
-
clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.
- Parameters:
clientRequestToken- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKey
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
- Parameters:
kmsKey- An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
languageCode
The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
- Parameters:
languageCode- The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
- Parameters:
languageCode- The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
StartEntitiesDetectionV2JobRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartEntitiesDetectionV2JobRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-