software.amazon.awssdk.services.comprehend.model

Class CreateEntityRecognizerRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEntityRecognizerRequest.Builder,CreateEntityRecognizerRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEntityRecognizerRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEntityRecognizerRequest.Builder	builder()
String	clientRequestToken() A unique identifier for the request.
String	dataAccessRoleArn() The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.
boolean	equals(Object obj)
<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()
EntityRecognizerInputDataConfig	inputDataConfig() Specifies the format and location of the input data.
LanguageCode	languageCode() The language of the input documents.
String	languageCodeAsString() The language of the input documents.
String	recognizerName() The name given to the newly created recognizer.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEntityRecognizerRequest.Builder>	serializableBuilderClass()
CreateEntityRecognizerRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

recognizerName

public String recognizerName()

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

Returns:

The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

dataAccessRoleArn

public String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Returns:

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

inputDataConfig

public EntityRecognizerInputDataConfig inputDataConfig()

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

Returns:

Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

clientRequestToken

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

languageCode

public LanguageCode languageCode()

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

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. Only English ("en") is currently supported.

See Also:

LanguageCode

languageCodeAsString

public String languageCodeAsString()

The language of the input documents. All documents must be in the same language. Only English ("en") is currently supported.

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. Only English ("en") is currently supported.

See Also:

LanguageCode

toBuilder

public CreateEntityRecognizerRequest.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<CreateEntityRecognizerRequest.Builder,CreateEntityRecognizerRequest>

Specified by:

toBuilder in class ComprehendRequest

Returns:

a builder for type T

builder

public static CreateEntityRecognizerRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateEntityRecognizerRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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