Interface EntityRecognizerProperties.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EntityRecognizerProperties.Builder,EntityRecognizerProperties>, SdkBuilder<EntityRecognizerProperties.Builder,EntityRecognizerProperties>, SdkPojo
Enclosing class:
EntityRecognizerProperties

public static interface EntityRecognizerProperties.Builder extends SdkPojo, CopyableBuilder<EntityRecognizerProperties.Builder,EntityRecognizerProperties>
  • Method Details

    • entityRecognizerArn

      EntityRecognizerProperties.Builder entityRecognizerArn(String 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

      EntityRecognizerProperties.Builder languageCode(String 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

      EntityRecognizerProperties.Builder trainingStartTime(Instant 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

      EntityRecognizerProperties.Builder trainingEndTime(Instant 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

      The input data properties of an entity recognizer.

      This is a convenience method that creates an instance of the EntityRecognizerInputDataConfig.Builder avoiding the need to create one manually via EntityRecognizerInputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputDataConfig(EntityRecognizerInputDataConfig).

      Parameters:
      inputDataConfig - a consumer that will call methods on EntityRecognizerInputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • recognizerMetadata

      EntityRecognizerProperties.Builder recognizerMetadata(EntityRecognizerMetadata 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 the EntityRecognizerMetadata.Builder avoiding the need to create one manually via EntityRecognizerMetadata.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to recognizerMetadata(EntityRecognizerMetadata).

      Parameters:
      recognizerMetadata - a consumer that will call methods on EntityRecognizerMetadata.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • dataAccessRoleArn

      EntityRecognizerProperties.Builder dataAccessRoleArn(String 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

      EntityRecognizerProperties.Builder 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. 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 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:
    • modelKmsKeyId

      EntityRecognizerProperties.Builder modelKmsKeyId(String 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

      EntityRecognizerProperties.Builder versionName(String 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

      EntityRecognizerProperties.Builder sourceModelArn(String 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

      EntityRecognizerProperties.Builder flywheelArn(String 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

      Output data configuration.

      Parameters:
      outputDataConfig - Output data configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputDataConfig

      Output data configuration.

      This is a convenience method that creates an instance of the EntityRecognizerOutputDataConfig.Builder avoiding the need to create one manually via EntityRecognizerOutputDataConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputDataConfig(EntityRecognizerOutputDataConfig).

      Parameters:
      outputDataConfig - a consumer that will call methods on EntityRecognizerOutputDataConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: