Class StartEntitiesDetectionV2JobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartEntitiesDetectionV2JobRequest.Builder,
StartEntitiesDetectionV2JobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A unique identifier for the request.final String
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final InputDataConfig
The input configuration that specifies the format and location of the input data for the job.final String
jobName()
The identifier of the job.final String
kmsKey()
An AWS Key Management Service key to encrypt your output files.final LanguageCode
The language of the input documents.final String
The language of the input documents.final OutputDataConfig
The output configuration that specifies where to send the output files.static Class
<? extends StartEntitiesDetectionV2JobRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
inputDataConfig
The input configuration that specifies the format and location of the input data for the job.
- Returns:
- The input configuration that specifies the format and location of the input data for the job.
-
outputDataConfig
The output configuration that specifies where to send the output files.
- Returns:
- The output configuration that specifies where to send the output files.
-
dataAccessRoleArn
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
- Returns:
- The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend Medical read access to your input data. For more information, see Role-Based Permissions Required for Asynchronous Operations.
-
jobName
The identifier of the job.
- Returns:
- The identifier of the job.
-
clientRequestToken
A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.
- Returns:
- A unique identifier for the request. If you don't set the client request token, Amazon Comprehend Medical generates one for you.
-
kmsKey
An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
- Returns:
- An AWS Key Management Service key to encrypt your output files. If you do not specify a key, the files are written in plain text.
-
languageCode
The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
- See Also:
-
languageCodeAsString
The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
If the service returns an enum value that is not available in the current SDK version,
languageCode
will returnLanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlanguageCodeAsString()
.- Returns:
- The language of the input documents. All documents must be in the same language. Amazon Comprehend Medical processes files in US English (en).
- See Also:
-
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 interfaceToCopyableBuilder<StartEntitiesDetectionV2JobRequest.Builder,
StartEntitiesDetectionV2JobRequest> - Specified by:
toBuilder
in classComprehendMedicalRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends StartEntitiesDetectionV2JobRequest.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-