Interface EntityRecognizerProperties.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<EntityRecognizerProperties.Builder,
,EntityRecognizerProperties> SdkBuilder<EntityRecognizerProperties.Builder,
,EntityRecognizerProperties> SdkPojo
- Enclosing class:
EntityRecognizerProperties
-
Method Summary
Modifier and TypeMethodDescriptiondataAccessRoleArn
(String dataAccessRoleArn) The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.The time that the recognizer creation completed.entityRecognizerArn
(String entityRecognizerArn) The Amazon Resource Name (ARN) that identifies the entity recognizer.flywheelArn
(String flywheelArn) The Amazon Resource Number (ARN) of the flywheelinputDataConfig
(Consumer<EntityRecognizerInputDataConfig.Builder> inputDataConfig) The input data properties of an entity recognizer.inputDataConfig
(EntityRecognizerInputDataConfig inputDataConfig) The input data properties of an entity recognizer.languageCode
(String languageCode) The language of the input documents.languageCode
(LanguageCode languageCode) The language of the input documents.A description of the status of the recognizer.modelKmsKeyId
(String modelKmsKeyId) ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.outputDataConfig
(Consumer<EntityRecognizerOutputDataConfig.Builder> outputDataConfig) Output data configuration.outputDataConfig
(EntityRecognizerOutputDataConfig outputDataConfig) Output data configuration.recognizerMetadata
(Consumer<EntityRecognizerMetadata.Builder> recognizerMetadata) Provides information about an entity recognizer.recognizerMetadata
(EntityRecognizerMetadata recognizerMetadata) Provides information about an entity recognizer.sourceModelArn
(String sourceModelArn) The Amazon Resource Name (ARN) of the source model.Provides the status of the entity recognizer.status
(ModelStatus status) Provides the status of the entity recognizer.submitTime
(Instant submitTime) The time that the recognizer was submitted for processing.trainingEndTime
(Instant trainingEndTime) The time that training of the entity recognizer was completed.trainingStartTime
(Instant trainingStartTime) The time that training of the entity recognizer started.versionName
(String versionName) The version name you assigned to the entity recognizer.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 a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer.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
-
entityRecognizerArn
The Amazon Resource Name (ARN) that identifies the entity recognizer.
- Parameters:
entityRecognizerArn
- The Amazon Resource Name (ARN) that identifies the entity recognizer.- 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. Only English ("en") is currently supported.
- Parameters:
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.- 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. Only English ("en") is currently supported.
- Parameters:
languageCode
- The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
Provides the status of the entity recognizer.
- Parameters:
status
- Provides the status of the entity recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
Provides the status of the entity recognizer.
- Parameters:
status
- Provides the status of the entity recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
message
A description of the status of the recognizer.
- Parameters:
message
- A description of the status of the recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
submitTime
The time that the recognizer was submitted for processing.
- Parameters:
submitTime
- The time that the recognizer was submitted for processing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The time that the recognizer creation completed.
- Parameters:
endTime
- The time that the recognizer creation completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingStartTime
The time that training of the entity recognizer started.
- Parameters:
trainingStartTime
- The time that training of the entity recognizer started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
trainingEndTime
The time that training of the entity recognizer was completed.
- Parameters:
trainingEndTime
- The time that training of the entity recognizer was completed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
The input data properties of an entity recognizer.
- Parameters:
inputDataConfig
- The input data properties of an entity recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
inputDataConfig
default EntityRecognizerProperties.Builder inputDataConfig(Consumer<EntityRecognizerInputDataConfig.Builder> inputDataConfig) The input data properties of an entity recognizer.
This is a convenience method that creates an instance of theEntityRecognizerInputDataConfig.Builder
avoiding the need to create one manually viaEntityRecognizerInputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toinputDataConfig(EntityRecognizerInputDataConfig)
.- Parameters:
inputDataConfig
- a consumer that will call methods onEntityRecognizerInputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
recognizerMetadata
Provides information about an entity recognizer.
- Parameters:
recognizerMetadata
- Provides information about an entity recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recognizerMetadata
default EntityRecognizerProperties.Builder recognizerMetadata(Consumer<EntityRecognizerMetadata.Builder> recognizerMetadata) Provides information about an entity recognizer.
This is a convenience method that creates an instance of theEntityRecognizerMetadata.Builder
avoiding the need to create one manually viaEntityRecognizerMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torecognizerMetadata(EntityRecognizerMetadata)
.- Parameters:
recognizerMetadata
- a consumer that will call methods onEntityRecognizerMetadata.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.
- Parameters:
dataAccessRoleArn
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.- 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 a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
- Parameters:
vpcConfig
- Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. 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 a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. 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:
-
modelKmsKeyId
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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:
modelKmsKeyId
- ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models. The ModelKmsKeyId 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.
-
-
versionName
The version name you assigned to the entity recognizer.
- Parameters:
versionName
- The version name you assigned to the entity recognizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceModelArn
The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.
- Parameters:
sourceModelArn
- The Amazon Resource Name (ARN) of the source model. This model was imported from a different Amazon Web Services account to create the entity recognizer model in your Amazon Web Services account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
flywheelArn
The Amazon Resource Number (ARN) of the flywheel
- Parameters:
flywheelArn
- The Amazon Resource Number (ARN) of the flywheel- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
EntityRecognizerProperties.Builder outputDataConfig(EntityRecognizerOutputDataConfig outputDataConfig) Output data configuration.
- Parameters:
outputDataConfig
- Output data configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputDataConfig
default EntityRecognizerProperties.Builder outputDataConfig(Consumer<EntityRecognizerOutputDataConfig.Builder> outputDataConfig) Output data configuration.
This is a convenience method that creates an instance of theEntityRecognizerOutputDataConfig.Builder
avoiding the need to create one manually viaEntityRecognizerOutputDataConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tooutputDataConfig(EntityRecognizerOutputDataConfig)
.- Parameters:
outputDataConfig
- a consumer that will call methods onEntityRecognizerOutputDataConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-