software.amazon.awssdk.services.comprehend.model

Class BatchDetectSyntaxRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<BatchDetectSyntaxRequest.Builder,BatchDetectSyntaxRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchDetectSyntaxRequest.Builder

Method Summary

Modifier and Type	Method and Description
static BatchDetectSyntaxRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTextList() For responses, this returns true if the service returned a value for the TextList property.
SyntaxLanguageCode	languageCode() The language of the input documents.
String	languageCodeAsString() The language of the input documents.
List<SdkField<?>>	sdkFields()
static Class<? extends BatchDetectSyntaxRequest.Builder>	serializableBuilderClass()
List<String>	textList() A list containing the UTF-8 encoded text of the input documents.
BatchDetectSyntaxRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasTextList

public final boolean hasTextList()

For responses, this returns true if the service returned a value for the TextList 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.

textList

public final List<String> textList()

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.

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 hasTextList() method.

Returns:

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.

languageCode

public final SyntaxLanguageCode languageCode()

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). 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 return SyntaxLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

See Also:

SyntaxLanguageCode

languageCodeAsString

public final String languageCodeAsString()

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). 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 return SyntaxLanguageCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from languageCodeAsString().

Returns:

The language of the input documents. You can specify any of the following languages supported by Amazon Comprehend: German ("de"), English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). All documents must be in the same language.

See Also:

SyntaxLanguageCode

toBuilder

public BatchDetectSyntaxRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BatchDetectSyntaxRequest.Builder,BatchDetectSyntaxRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static BatchDetectSyntaxRequest.Builder builder()

serializableBuilderClass

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