software.amazon.awssdk.services.comprehend.model

Class ImportModelRequest

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.ImportModelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportModelRequest.Builder,ImportModelRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportModelRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ImportModelRequest.Builder	builder()
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
String	modelKmsKeyId() ID for the KMS key that Amazon Comprehend uses to encrypt trained custom models.
String	modelName() The name to assign to the custom model that is created in Amazon Comprehend by this import.
List<SdkField<?>>	sdkFields()
static Class<? extends ImportModelRequest.Builder>	serializableBuilderClass()
String	sourceModelArn() The Amazon Resource Name (ARN) of the custom model to import.
List<Tag>	tags() Tags to associate with the custom model that is created by this import.
ImportModelRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	versionName() The version name given to the custom model that is created by this import.

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

sourceModelArn

public final String sourceModelArn()

The Amazon Resource Name (ARN) of the custom model to import.

Returns:

The Amazon Resource Name (ARN) of the custom model to import.

modelName

public final String modelName()

The name to assign to the custom model that is created in Amazon Comprehend by this import.

Returns:

The name to assign to the custom model that is created in Amazon Comprehend by this import.

versionName

public final String versionName()

The version name given to the custom model that is created by this import. 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 account/Region.

Returns:

The version name given to the custom model that is created by this import. 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 account/Region.

modelKmsKeyId

public final String 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"

dataAccessRoleArn

public final String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

Returns:

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend permission to use Amazon Key Management Service (KMS) to encrypt or decrypt the custom model.

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 custom model that is created by this import. 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 custom model that is created by this import. 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.

toBuilder

public ImportModelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportModelRequest.Builder,ImportModelRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static ImportModelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportModelRequest.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