StartEntitiesDetectionJobRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class StartEntitiesDetectionJobRequest
extends ComprehendRequest
implements ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartEntitiesDetectionJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartEntitiesDetectionJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartEntitiesDetectionJobRequest.Builder`	`builder()`
`String`	`clientRequestToken()` A unique identifier for the request.
`String`	`dataAccessRoleArn()` The Amazon Resource Name (ARN) of the AWS Identity and Access Management (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)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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()`
`StartEntitiesDetectionJobRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeKmsKeyId()` ID for the AWS 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
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 AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions< /a>.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role- 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 AWS 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 AWS 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.
  - toBuilder
```
public StartEntitiesDetectionJobRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>
    
    Specified by:
    
    toBuilder in class ComprehendRequest
    
    Returns:
    
    a builder for type T
  - 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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.15.69

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.