@Generated(value="software.amazon.awssdk:codegen") public final class StartEntitiesDetectionJobRequest extends ComprehendRequest implements ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
StartEntitiesDetectionJobRequest.Builder |
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.
|
overrideConfiguration
copy
public final InputDataConfig inputDataConfig()
Specifies the format and location of the input data for the job.
public final OutputDataConfig outputDataConfig()
Specifies where to send the output files.
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>.
public final String jobName()
The identifier of the job.
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.
StartEntitiesDetectionJob
. This ARN is optional and is only used for a custom entity
recognition job.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()
.
LanguageCode
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()
.
LanguageCode
public final String clientRequestToken()
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.
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"
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"
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.
public StartEntitiesDetectionJobRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartEntitiesDetectionJobRequest.Builder,StartEntitiesDetectionJobRequest>
toBuilder
in class ComprehendRequest
public static StartEntitiesDetectionJobRequest.Builder builder()
public static Class<? extends StartEntitiesDetectionJobRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.