Class CreateDocumentClassifierRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDocumentClassifierRequest.Builder,
CreateDocumentClassifierRequest>
-
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 IAM role that grants Amazon Comprehend read access to your input data.final String
The name of the document classifier.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 boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Specifies the format and location of the input data for the job.final LanguageCode
The language of the input documents.final String
The language of the input documents.final DocumentClassifierMode
mode()
Indicates the mode in which the classifier will be trained.final String
Indicates the mode in which the classifier will be trained.final String
ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.final String
The resource-based policy to attach to your custom document classifier model.Specifies the location for the output files from a custom classifier job.static Class
<? extends CreateDocumentClassifierRequest.Builder> tags()
Tags to associate with the document classifier.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.final String
The version name given to the newly created classifier.final String
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.final VpcConfig
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentClassifierName
The name of the document classifier.
- Returns:
- The name of the document classifier.
-
versionName
The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
- Returns:
- The version name given to the newly created classifier. Version names can have a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The version name must be unique among all models with the same classifier name in the Amazon Web Services account/Amazon Web Services Region.
-
dataAccessRoleArn
The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
- Returns:
- The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend read access to your input data.
-
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 theisEmpty()
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
Tags to associate with the document classifier. A tag is a key-value pair that adds as a 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 document classifier. A tag is a key-value pair that adds as a 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.
-
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
Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.
- Returns:
- Specifies the location for the output files from a custom classifier job. This parameter is required for a request that creates a native document model.
-
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.
-
languageCode
The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
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. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
- See Also:
-
languageCodeAsString
The language of the input documents. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
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. You can specify any of the languages supported by Amazon Comprehend. All documents must be in the same language.
- See Also:
-
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
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. 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 custom classifier. For more information, see Amazon VPC.
-
mode
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
If the service returns an enum value that is not available in the current SDK version,
mode
will returnDocumentClassifierMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
- See Also:
-
modeAsString
Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
If the service returns an enum value that is not available in the current SDK version,
mode
will returnDocumentClassifierMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommodeAsString()
.- Returns:
- Indicates the mode in which the classifier will be trained. The classifier can be trained in multi-class (single-label) mode or multi-label mode. Multi-class mode identifies a single class label for each document and multi-label mode identifies one or more class labels for each document. Multiple labels for an individual document are separated by a delimiter. The default delimiter between labels is a pipe (|).
- See Also:
-
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:
- 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"
-
-
-
modelPolicy
The resource-based policy to attach to your custom document classifier model. You can use this policy to allow another Amazon Web Services account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
- Returns:
- The resource-based policy to attach to your custom document classifier model. You can use this policy to
allow another Amazon Web Services account to import your custom model.
Provide your policy as a JSON body that you enter as a UTF-8 encoded string without line breaks. To provide valid JSON, enclose the attribute names and values in double quotes. If the JSON body is also enclosed in double quotes, then you must escape the double quotes that are inside the policy:
"{\"attribute\": \"value\", \"attribute\": [\"value\"]}"
To avoid escaping quotes, you can use single quotes to enclose the policy and double quotes to enclose the JSON names and values:
'{"attribute": "value", "attribute": ["value"]}'
-
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<CreateDocumentClassifierRequest.Builder,
CreateDocumentClassifierRequest> - Specified by:
toBuilder
in classComprehendRequest
- Returns:
- a builder for type T
-
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
-