java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.comprehend.model.ComprehendRequest
    - - software.amazon.awssdk.services.comprehend.model.StartEntitiesDetectionJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartEntitiesDetectionJobRequest
extends ComprehendRequest
implements ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartEntitiesDetectionJobRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartEntitiesDetectionJobRequest.Builder`	`builder()`
`String`	`clientRequestToken()`	A unique identifier for the request.
`String`	`dataAccessRoleArn()`	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
`String`	`entityRecognizerArn()`	The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the `StartEntitiesDetectionJob`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`flywheelArn()`	The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`InputDataConfig`	`inputDataConfig()`	Specifies the format and location of the input data for the job.
`String`	`jobName()`	The identifier of the job.
`LanguageCode`	`languageCode()`	The language of the input documents.
`String`	`languageCodeAsString()`	The language of the input documents.
`OutputDataConfig`	`outputDataConfig()`	Specifies where to send the output files.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartEntitiesDetectionJobRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	Tags to associate with the entities detection job.
`StartEntitiesDetectionJobRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`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`	`vpcConfig()`	Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - inputDataConfig
```
public final InputDataConfig inputDataConfig()
```
    Specifies the format and location of the input data for the job.
    
    Returns:
    
    Specifies the format and location of the input data for the job.
  - outputDataConfig
```
public final OutputDataConfig outputDataConfig()
```
    Specifies where to send the output files.
    
    Returns:
    
    Specifies where to send the output files.
  - dataAccessRoleArn
```
public final String 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:
    
    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.
  - jobName
```
public final String jobName()
```
    The identifier of the job.
    
    Returns:
    
    The identifier of the job.
  - entityRecognizerArn
```
public final String entityRecognizerArn()
```
    The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
    
    Returns:
    
    The Amazon Resource Name (ARN) that identifies the specific entity recognizer to be used by the StartEntitiesDetectionJob. This ARN is optional and is only used for a custom entity recognition job.
  - languageCode
```
public final LanguageCode languageCode()
```
    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
    
    See Also:
    
    LanguageCode
  - languageCodeAsString
```
public final String languageCodeAsString()
```
    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
    
    If the service returns an enum value that is not available in the current SDK version, languageCode will return LanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().
    
    Returns:
    
    The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.
    
    See Also:
    
    LanguageCode
  - clientRequestToken
```
public final String clientRequestToken()
```
    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
    
    Returns:
    
    A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
  - volumeKmsKeyId
```
public final 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"
    Returns:
    
    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"
  - vpcConfig
```
public final VpcConfig vpcConfig()
```
    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
    
    Returns:
    
    Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final List<Tag> tags()
```
    Tags to associate with the entities 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    Tags to associate with the entities 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.
  - flywheelArn
```
public final String flywheelArn()
```
    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
    
    Returns:
    
    The Amazon Resource Number (ARN) of the flywheel associated with the model to use.
  - toBuilder
```
public StartEntitiesDetectionJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>
    
    Specified by:
    
    toBuilder in class ComprehendRequest
  - builder
```
public static StartEntitiesDetectionJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartEntitiesDetectionJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartEntitiesDetectionJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

inputDataConfig

outputDataConfig

dataAccessRoleArn

jobName

entityRecognizerArn

languageCode

languageCodeAsString

clientRequestToken

volumeKmsKeyId

vpcConfig

hasTags

tags

flywheelArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields